Skip to content
This repository was archived by the owner on Jul 23, 2025. It is now read-only.

Commit 859b18c

Browse files
committed
Added a detailed changelog to SPEC file
Reworked project documentation for clarity Signed-off-by: Akashdeep Dhar <[email protected]>
1 parent 515879d commit 859b18c

File tree

2 files changed

+105
-38
lines changed

2 files changed

+105
-38
lines changed

README.md

Lines changed: 34 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -9,60 +9,67 @@
99
<img src="https://img.shields.io/github/license/t0xic0der/nvidia-auto-installer-for-fedora?style=flat-square&logo=appveyor&color=teal">
1010
</p>
1111

12-
## Screenshots
13-
Find all the shiny stuff [here](SCREENSHOTS.md).
14-
1512
## Requirements
1613
* Active internet connection
1714
* Fedora 32 or above
1815

16+
## Installation
17+
18+
If you use Fedora (32, 33, 34 ELN, Rawhide or above), CentOS (Stream 8 or above), RHEL (8 or above),
19+
Mageia (7, Cauldron or above), OpenSUSE (Leap or Tumbleweed) - you can install NVIDIA Auto Installer for Fedora
20+
by enabling my COPR repository. Simply execute the following commands in succession to install the tool.
21+
22+
```shell
23+
# dnf install dnf-plugins-core -y
24+
# dnf copr enable t0xic0der/nvidia-auto-installer-for-fedora -y
25+
# dnf install nvautoinstall -y
26+
```
27+
1928
## Usage
2029
1. Make sure you have a working internet connection
21-
2. Download `NVAutoInstFedora32` from the latest release
22-
3. Make the binary executable by running `chmod +x NVAutoInstFedora32`
23-
3. Execute `sudo ./NVAutoInstFedora32` to check installation modes
24-
4. Give stars to the repository if you found this helpful
30+
2. Install the tool from COPR with the above instructions
31+
3. Execute `nvautoinstall` to check installation modes
32+
4. Run the installation modes according to your needs
33+
5. Give stars to the repository if you found this helpful
2534

2635
## Modes of installation
2736
Active internet connection and superuser privilege is required to execute the following installation modes.
28-
- **`sudo ./NVAutoInstFedora32 --rpmadd`**
37+
- **`sudo nvautoinstall --rpmadd`**
2938
This mode enables the RPM Fusion NVIDIA drivers repository.
30-
- **`sudo ./NVAutoInstFedora32 --driver`**
39+
- **`sudo nvautoinstall --driver`**
3140
This mode simply installs the NVIDIA drivers (with x86_64 deps only). Enabling the RPM Fusion NVIDIA drivers repository is mandatory before doing this.
32-
- **`sudo ./NVAutoInstFedora32 --x86lib`**
41+
- **`sudo nvautoinstall --x86lib`**
3342
This mode installs only the x86 libraries for Xorg. Enabling the RPM Fusion NVIDIA drivers repository and installing the basic drivers are mandatory before doing this.
34-
- **`sudo ./NVAutoInstFedora32 --nvrepo`**
43+
- **`sudo nvautoinstall --nvrepo`**
3544
This mode enables the official NVIDIA repository for CUDA software.
36-
- **`sudo ./NVAutoInstFedora32 --plcuda`**
45+
- **`sudo nvautoinstall --plcuda`**
3746
This mode installs only the CUDA support softwares. Enabling the RPM Fusion NVIDIA drivers and NVIDIA official repository, and installing the basic drivers are mandatory before doing this.
38-
- **`sudo ./NVAutoInstFedora32 --ffmpeg`**
47+
- **`sudo nvautoinstall --ffmpeg`**
3948
This mode installs only the FFMPEG accleration. Enabling the RPM Fusion NVIDIA drivers repository and installing the basic drivers are mandatory before doing this.
40-
- **`sudo ./NVAutoInstFedora32 --vulkan`**
49+
- **`sudo nvautoinstall --vulkan`**
4150
This mode installs only the Vulkan renderer. Enabling the RPM Fusion NVIDIA drivers repository and installing the basic drivers are mandatory before doing this.
42-
- **`sudo ./NVAutoInstFedora32 --vidacc`**
51+
- **`sudo nvautoinstall --vidacc`**
4352
This mode installs only the VDPAU/VAAPI acceleration. Enabling the RPM Fusion NVIDIA drivers repository and installing the basic drivers are mandatory before doing this.
44-
- **`sudo ./NVAutoInstFedora32 --getall`**
53+
- **`sudo nvautoinstall --getall`**
4554
This mode installs all the above packages. (Not been implemented yet)
46-
- **`sudo ./NVAutoInstFedora32 --cheksu`**
55+
- **`sudo nvautoinstall --cheksu`**
4756
This mode allows you to check the current user privilege level. You can use this tool effectively only when you have logged in as a root or sudo user.
48-
- **`sudo ./NVAutoInstFedora32 --compat`**
57+
- **`sudo nvautoinstall --compat`**
4958
This mode allows you to check your hardware and host compatiblity. The tool would check your hardware and host and tell if your device is supported by the tool or not.
50-
- **`sudo ./NVAutoInstFedora32 --version`**
59+
- **`sudo nvautoinstall --version`**
5160
This mode would show the tool version and exit out.
52-
- **`sudo ./NVAutoInstFedora32 --help`**
61+
- **`sudo nvautoinstall --help`**
5362
This mode would show the help message and exit out.
5463

5564
## Note
5665
* Active internet connection is required to download drivers.
5766
* Requires secure boot to be turned off in UEFI systems.
5867
* Requires superuser access for repo addition and driver setup.
5968
* The drivers are fetched from the RPMFusion repository.
60-
* Only tested on Fedora 32 Workstation.
6169
* Use discretion while using this on other spins.
6270
* Only tested on 9XX/10XX/20XX series discrete cards.
6371
* Use discretion while installing with older cards.
6472
* No additional configuration is required for Optimus setups.
65-
* Consider using executables provided in releases section only.
6673

6774
## Coming soon
6875
* CLI "Launch using Dedicated Graphics Card" option.
@@ -73,4 +80,8 @@ This mode would show the help message and exit out.
7380
* Native support for PRIME configuration on Optimus.
7481

7582
## Disclaimer
76-
This tool has been tried and tested multiple times and is expected to work flawlessly in Fedora Workstation 32 or above. It has not been tested on any of the spins yet so proceed with caution. While the chances of things going wrong is pretty slim but still you would want to make backups, should things do not go as expected. As always, you are choosing to use this tool at your will and you cannot hold me responsible for any mishap there may occur due to the misuse of this tool.
83+
This tool has been tried and tested multiple times and is expected to work flawlessly in Fedora Workstation 32 or
84+
above. It has not been tested on any of the spins yet so proceed with caution. While the chances of things going wrong
85+
is pretty slim but still you would want to make backups, should things do not go as expected. As always, you are
86+
choosing to use this tool at your will and you cannot hold me responsible for any mishap there may occur due to the
87+
misuse of this tool.

nvautoinstall.spec

Lines changed: 71 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -3,29 +3,20 @@
33
Name: nvautoinstall
44
Version: 0.3.5
55
Release: 0%{?dist}
6+
Summary: NVIDIA Auto Installer for Fedora
7+
68
License: GPLv3
7-
Summary: A CLI tool that helps you install proprietary NVIDIA drivers and much more
89
Url: https://github.com/t0xic0der/%{srcname}
9-
Source0: https://github.com/t0xic0der/%{srcname}/archive/%{name}-%{version}.tar.gz
10+
Source0: https://github.com/t0xic0der/%{srcname}/releases/download/%{version}/%{name}-%{version}.tar.gz
1011

1112
BuildArch: noarch
1213

13-
%if 0%{?el6}
14-
BuildRequires: python34-devel
15-
BuildRequires: python34-setuptools
16-
%else
1714
BuildRequires: python3-devel
1815
BuildRequires: python3-setuptools
19-
%endif
2016

2117
%description
22-
NVAutoInstall is a small CLI tool designed to facilitate installation of the
23-
proprietary NVidia graphics drivers & related tools. It supports installation
24-
of base drivers, CUDA software, Vulkan, VDPAU/VDAAPI and FFMPEG acceleration
25-
as well as check your system for compatibility and manage RPMFusion and NVidia
26-
repositories.
18+
A CLI tool which lets you install proprietary NVIDIA drivers and much more
2719

28-
#-- PREP, BUILD & INSTALL -----------------------------------------------------#
2920
%prep
3021
%autosetup
3122

@@ -38,12 +29,77 @@ repositories.
3829
#-- FILES ---------------------------------------------------------------------#
3930
%files
4031
%doc README.md
41-
%doc pics/
42-
%doc SCREENSHOTS.md
4332
%license LICENSE
4433
%{_bindir}/nvautoinstall
4534
%{python3_sitelib}/%{name}-*.egg-info/
4635
%{python3_sitelib}/%{name}/
4736

4837
#-- CHANGELOG -----------------------------------------------------------------#
4938
%changelog
39+
* Thu Apr 29 2021 Akashdeep Dhar <[email protected]>
40+
- v0.3.5
41+
- Corrected unicode escape sequences for colors
42+
- Changed CUDA repository to the most recent F33 remote install
43+
- Fixed imports for development/packaged environment
44+
- Refactored the code to remove needless lines
45+
- Made compliance related changes here and there
46+
- Tested and confirmed the tool to be working in F34 Workstation
47+
* Thu Jun 04 2020 Akashdeep Dhar <[email protected]>
48+
- v0.3.0
49+
- Combined RPM Fusion pinging, checking, installing into a single module
50+
- Combined driver installer and existing package checking into a single module
51+
- Combined host detection with GPU support checking into a single module
52+
- Revamped installation mode using command line arguments
53+
- Withdrew x86 libraries from the default installation mode
54+
- Added a new x86 libraries mode of installation for Xorg
55+
- Added integrated CUDA module for repository checking, adding and installing
56+
- Added support for FFMPEG acceleration using NVENC/NVDEC
57+
- Added dedicated privilege check for each installation mode
58+
- Added video hardware acceleration using VDPAU/VAAPI
59+
- Added support for installation of Vulkan renderer
60+
- Placeholder added for install everything mode of installation (Yet to be completed)
61+
- Converged all low-level module operations into a single file for speed
62+
- All print operations have been replaced by click-echo for optimization
63+
- Added checks for NVIDIA repository and RPM Fusion repository availability
64+
- Added network availability check before pinging respective repo servers
65+
- Improved handling of interrupt. halt and suspend system calls for tool
66+
* Mon Jun 01 2020 Akashdeep Dhar <[email protected]>
67+
- v0.2.6
68+
- Fixed broken repository addition module
69+
- Added installation of fedora-workstation-repositories first
70+
- Added enabling of repository after the install is complete
71+
* Sun May 31 2020 Akashdeep Dhar <[email protected]>
72+
- v0.2.5
73+
- Removed mandatory sleep for kernel module load
74+
- Removed dependency on kernel module loader
75+
- Removed kernel module force-read altogether
76+
- Defaulted textual messages to autocolor for better legibility
77+
- Fixed boolean choices in main function
78+
- Fixed boolean choices in package check
79+
- Fixed prompt colors for custom-themed terminals
80+
* Wed May 27 2020 Akashdeep Dhar <[email protected]>
81+
- v0.2.0
82+
- Cleaned up repeated code using class implemented decorator calls
83+
- Enforced root access for whole operation instead of sudo implementation
84+
- Added support for x86 libraries of Xorg display server
85+
- Added distribution identification with support status display
86+
- Scaled up to accompany Workstation as well as Fedora Spins
87+
- Added dedicated status check for driver installation
88+
- Added dedicated status check for kernel module reader
89+
- Fixed confirmation choice during package check
90+
- Fixed typo in RPM Fusion mentions throughout the tool interface
91+
* Fri May 22 2020 Akashdeep Dhar <[email protected]>
92+
- v0.1.0
93+
- Added host detection with display of system details and hostname
94+
- Added GPU compatibility check for detecting active NVIDIA GPU
95+
- Added detection for Optimus Dual GPU and dedicated GPU setups
96+
- Declination to install if no active NVIDIA GPU is detected
97+
- Added check for existing driver installations with listing of packages
98+
- Added ability to install over an existing driver installation
99+
- Added reachability check for RPMFusion servers before fetching
100+
- Added automatic fetching and enabling of RPMFusion NVIDIA Repo
101+
- Declination to install if repository addition is voluntarily cancelled
102+
- Added skipping repo fetch and update if repository is present
103+
- Added exclusive 64-bit driver installation with kernel load sleeptime
104+
- Added forced kernel config read events with forced sleeptime
105+
- Added restart feature activated with consent of the user

0 commit comments

Comments
 (0)