Added 'usage' docs. Updated to v1.3

ciorceri · Sep 10, 2019 · 99a9884 · 99a9884
1 parent 596c347
commit 99a9884
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -15,7 +15,23 @@
 
 #### Future features:
     - Support for ADIF & Cabrillo logs with generic and rules based validator
-
+
+#### Usage
+To run the tool using source code you need Python 3.6 or Python 3.7
+
+    - For Windows download and install from: https://www.python.org/downloads/
+    - For Ubuntu install using:
+        $ sudo apt-get update
+        $ sudo apt-get install python3.7
+        $ sudo apt-get install python3-pip
+    - MacOS install using:
+        $ brew install python3
+
+Install tool requirements using command:
+
+    $ cd logXchecker
+    $ pip3 install -r requirements.txt
+
 #### Current VHF rules format (this format may be subject to change):
 ```
 [contest]

diff --git a/version.py b/version.py
@@ -1,2 +1,2 @@
 __project__ = "logXchecker"
-__version__ = "1.2"
+__version__ = "1.3"