From dc6fc1bf3218adc7cc79906acfda1341df730c22 Mon Sep 17 00:00:00 2001 From: TangoBravo14 Date: Sun, 24 Feb 2019 05:22:50 +0000 Subject: [PATCH] Update README.md --- README.md | 43 ++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 42 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 5703ab7..bfeb9cc 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,44 @@ # setup scripts -This project will host tools to assist with setting up and configuring Debian based systems and Raspberry Pi with ham radio tools and security software. \ No newline at end of file +############################################################################### + +Versioning: + +X.X.X.X +| | | | +---------- Major release. 1.0 will occur when testing and features are finalized + | | | + ---------- Minor release. Significant change in features / operations + | | + ---------- Sub-release. Adding functions etc. + | + ---------- Fixes. Modifications due to typos, errors, etc. + +############################################################################### + +To run this program it is recommended to open a terminal, resize the window to full screen, make the script executable and run it. +You can make it executable by typing: + +chmod +x 'filename' + +You can then run it with: + +./'filename' + +Alternatively, a 'debug' mode can be used to see what errors occur by running with: + +bash -x filename + +You could also run the script by double clicking and selecting 'Run in terminal' but any errors will simply close the session and you won't know what errored or why. + +If you run into errors, please attempt again and run with bash -x to see the output. If you can provide the final section of that that shows the error along with your system information it will assist in troubleshooting. Thank you. + + + +#### TO DO ################################################################## +# +# Figure out Electrum on Pi and systems with less than python 3.6.1 +# add version checking for bitmessage +# SDR tools +# Add VOACAP version checking +############################################################################ \ No newline at end of file