RepoMirrors
/
nvchecker
mirror of https://github.com/lilydjwg/nvchecker
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update README.rst about installation and running

This commit is contained in:
lilydjwg 2018-08-01 16:10:04 +08:00
parent 3e915a6a39
commit 0c459c1c03
1 changed files with 15 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
README.rst
View File

@ -11,7 +11,7 @@ Contents
======== ========
* `Dependency <#dependency>`_ * `Dependency <#dependency>`_
* `Running <#running>`_ * `Install and Run <#running>`_
* `JSON logging <#json-logging>`_ * `JSON logging <#json-logging>`_
@ -60,15 +60,23 @@ Dependency
- All commands used in your version source files - 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:: To see available options::
./nvchecker --help nvchecker --help
Run with one or more software version source files:: 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. 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``:: 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``:: 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):: Manually compare the two files for updates (assuming they are sorted alphabetically; files generated by ``nvchecker`` are already sorted)::