From d220ff371ded0c2ac1d9ed88e4e86de56607bc4a Mon Sep 17 00:00:00 2001 From: TangoBravo14 Date: Sun, 24 Feb 2019 08:17:30 +0000 Subject: [PATCH] Updated installation instructions --- README.md | 42 +++++++++++++++++++++++++++++++++++------- 1 file changed, 35 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 06aacee..ed51496 100644 --- a/README.md +++ b/README.md @@ -1,23 +1,51 @@ # AmRRON Setup Scripts -To run these programs it is recommended to open a terminal, make the script executable and run it. -You can make it executable by typing: +# Installation -chmod +x filename +You will need get to clone this repository on your system. Install git with: + sudo apt install git -You can then run it with: +Now clone the repository to your local system: -./filename + git clone https://gitlab.com/amrron/setup-scripts.git + +Move into the new directory: + + cd setup-scripts + +To get updates to the scripts, ensure you are in the setup-scripts directory and run: + + git pull + +# Running the scripts + +To run a script simply type: + + ./filename Alternatively, a bash 'debug' mode can be used to see what the script is doing by running with: -bash -x filename + 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. +You could also run the script by double clicking and selecting 'Run in terminal' from you file browser 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. +# Common Errors + - Hamlib and the FLDIGI suite are hosted on sourceforge. Lately it appears sourceforge has periods of down time. If the script is unable to download one of these programs or query sourceforge for the current version, you should receive an error message at the end of the install process. These problems are usually fixed by simply re-running the setup script later and selecting the items that failed to download. + - If Hamlib fails to be installed before FLDigi is compiled, FLDigi will be compiled without hamlib support. If you need that functionality do the following after you successfully install hamlib: + + cd ~/Radio/fldigi-4.1.01 + # Use the appropriate version number + + ./configure --enable-optimizations=native + # (For Pi, do not add the enable optimizations) + # You should see hamlib support marked yes + + make && sudo make install + + #TO-DO