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

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.

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.

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.

Examples

Here is real commands used for Windows driver 441.28 and 512.95 series:

./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
./add_driver.py -W -P GeForce --variant "DCH" -w win10 512.95

Variant DCH: Microsoft DCH (Declarative Componentized Hardware supported apps) drivers refers to a new universal Windows 10 driver package. NVIDIA FAQ

Synopsis

$ ./add_driver.py --help
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

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:
  --variant VARIANT     driver variant (use for special cases like "Studio Driver") (default: )
  -P {GeForce,Quadro}, --product {GeForce,Quadro}
                        product type (default: GeForce)
  -w {win10,win7,ws2012,ws2016}, --winseries {win10,win7,ws2012,ws2016}
                        Windows series (default: win10)
  --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)
  --skip-patch-check    skip patch files presense test (default: False)