From 0c459c1c030e07f2c8732641f3e11fa14d2e7ca2 Mon Sep 17 00:00:00 2001 From: lilydjwg Date: Wed, 1 Aug 2018 16:10:04 +0800 Subject: [PATCH] Update README.rst about installation and running --- README.rst | 22 +++++++++++++++------- 1 file changed, 15 insertions(+), 7 deletions(-) diff --git a/README.rst b/README.rst index a2aaa71..dbd2977 100644 --- a/README.rst +++ b/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)::