Update README.rst about installation and running
This commit is contained in:
parent
3e915a6a39
commit
0c459c1c03
22
README.rst
22
README.rst
|
@ -11,7 +11,7 @@ Contents
|
|||
========
|
||||
|
||||
* `Dependency <#dependency>`_
|
||||
* `Running <#running>`_
|
||||
* `Install and Run <#running>`_
|
||||
|
||||
* `JSON logging <#json-logging>`_
|
||||
|
||||
|
@ -60,15 +60,23 @@ Dependency
|
|||
|
||||
- All commands used in your version source files
|
||||
|
||||
Running
|
||||
=======
|
||||
Install and Run
|
||||
===============
|
||||
To install::
|
||||
|
||||
pip3 install nvchecker
|
||||
|
||||
To use the latest code, you can also clone this repository and run::
|
||||
|
||||
python3 setup.py install
|
||||
|
||||
To see available options::
|
||||
|
||||
./nvchecker --help
|
||||
nvchecker --help
|
||||
|
||||
Run with one or more software version source files::
|
||||
|
||||
./nvchecker source_file
|
||||
nvchecker source_file
|
||||
|
||||
You normally will like to specify some "version record files"; see below.
|
||||
|
||||
|
@ -106,11 +114,11 @@ Version record files record which version of the software you know or is availab
|
|||
|
||||
Say you've got a version record file called ``old_ver.txt`` which records all your watched software and their versions, as well as some configuration entries. To update it using ``nvchecker``::
|
||||
|
||||
./nvchecker source.ini
|
||||
nvchecker source.ini
|
||||
|
||||
See what are updated with ``nvcmp``::
|
||||
|
||||
./nvcmp source.ini
|
||||
nvcmp source.ini
|
||||
|
||||
Manually compare the two files for updates (assuming they are sorted alphabetically; files generated by ``nvchecker`` are already sorted)::
|
||||
|
||||
|
|
Loading…
Reference in New Issue