nvidia-patch/tools/readme-autogen/README.md

71 lines
2.3 KiB
Markdown
Raw Normal View History

readme-autogen
==============
readme-autogen is a tool for internal usage, which purpose is to simplify maintenance of fresh and correct README files for this project.
2019-11-15 01:38:09 +00:00
It rebuilds REAME files from templates located in `templates` directory and driver data specified in `drivers.json` file.
## Requirements
* Python 3.4+
## Usage
Just run script. It will update files in your repo working copy.
2019-11-18 21:44:27 +00:00
add\_driver
==========
add\_driver is a tool for internal usage, which purpose is to simplify proper introduction of new driver records into `drivers.json` file.
## Requirements
* Python 3.4+
## Usage
Just run script. It will update files in your repo working copy.
2019-11-18 22:02:36 +00:00
## Examples
Here is real commands used for Windows driver 441.28 series:
```bash
./add_driver.py -W --variant "Studio Driver" 441.28
./add_driver.py -W -P Quadro -w win10 441.28
./add_driver.py -W -P Quadro -w win7 441.28
./add_driver.py -W -P Quadro -w ws2012 441.28
./add_driver.py -W -P Quadro -w ws2016 441.28
```
2019-11-18 21:44:27 +00:00
## Synopsis
```
$ ./add_driver.py --help
2020-07-03 19:49:10 +00:00
usage: add_driver.py [-h] (-L | -W) [--variant VARIANT] [-P {GeForce,Quadro}] [-w {win10,win7,ws2012,ws2016}] [--patch32 PATCH32] [--patch64 PATCH64] [--skip-patch-check] [-U URL] [--skip-url-check] version
2019-11-18 21:44:27 +00:00
Adds new Nvidia driver into drivers.json file of in your repo working copy
positional arguments:
version driver version
optional arguments:
-h, --help show this help message and exit
-U URL, --url URL override driver link (default: None)
--skip-url-check skip driver URL check (default: False)
OS options:
-L, --linux add Linux driver (default: None)
-W, --win add Windows driver (default: None)
Windows-specific options:
2020-07-03 19:49:10 +00:00
--variant VARIANT driver variant (use for special cases like "Studio Driver") (default: )
2019-11-18 21:44:27 +00:00
-P {GeForce,Quadro}, --product {GeForce,Quadro}
product type (default: GeForce)
-w {win10,win7,ws2012,ws2016}, --winseries {win10,win7,ws2012,ws2016}
Windows series (default: win10)
2020-07-03 19:49:10 +00:00
--patch32 PATCH32 template for Windows 32bit patch URL (default: ${winseries}_x64/${drvprefix}${version}/nvencodeapi.1337)
--patch64 PATCH64 template for Windows 64bit patch URL (default: ${winseries}_x64/${drvprefix}${version}/nvencodeapi64.1337)
2019-11-18 21:44:27 +00:00
--skip-patch-check skip patch files presense test (default: False)
```