Merge pull request #52 from Boneill3/master

Various updates and cleaning

README.md

@@ -31,9 +31,13 @@ An NCurses-based TUI application for tracking activity over the CAN bus and deco
 ***
 
 # Configuration
+The default configurations provided by CANOpen Monitor can be found in 
+[canopen_monitor/assets](./canopen_monitor/assets). These are the default 
+assets provided. At runtime these configs are copied to 
+`~/.config/canopen-monitor` where they can be modified and the changes 
+will persist.
 
-The default configurations provided by CANOpen Monitor can be found in [canopen_monitor/assets](./canopen_monitor/assets). These are the default assets provided. At runtime these configs are copied to `~/.config/canopen-monitor` where they can be modified and the changes will persist.
-
+EDS files are loaded from `~/.cache/canopen-monitor`
 ***
 
 # Development and Contribution
@@ -42,13 +46,39 @@ The default configurations provided by CANOpen Monitor can be found in [canopen_
 
 Check out our [Read The Docs](https://canopen-monitor.readthedocs.io) pages for more info on the application sub-components and methods.
 
+### Pre-Requisites
+* Ubuntu/Debian Linux System
+
+* Python 3.8.5 or higher (pyenv is recommended for managing different python versions, https://realpython.com/intro-to-pyenv/#build-dependencies)
+
 ### Install Locally
 
+#### Setup a virtual CAN signal generator
+`$` `sudo apt-get install can-utils`
+
+#### Start a virtual CAN
+`$` `sudo ip link add dev vcan0 type vcan`
+
+`$` `sudo ip link set up vcan0`
+
+#### Clone the repo
+`$` `git clone https://github.com/Boneill3/CANopen-monitor.git`
+
+`$` `cd CANopen-monitor`
+
 `$` `pip install -e .[dev]`
 
 *(Note: the `-e` flag creates a symbolic-link to your local development version. Set it once, and forget it)*
 
-### Create Documentation Locally
+#### Generate random messages with socketcan-dev
+`$` `chmod 700 socketcan-dev`
+
+`$` `./socketcan-dev.py --random-id --random-message -r`
+
+#### Start the monitor
+`$` `canopen-monitor`
+
+### Create documentation locally
 
 `$` `make -C docs clean html`
 

canopen_monitor/__init__.py

@@ -2,7 +2,7 @@
 
 MAJOR = 3
 MINOR = 2
-PATCH = 2
+PATCH = 3
 
 APP_NAME = 'canopen-monitor'
 APP_DESCRIPTION = 'An NCurses-based TUI application for tracking activity' \