Merge branch 'master' of gitlab.com:eliggett/wfview

INSTALL.md

@@ -0,0 +1,39 @@
+# How to install wfview
+
+### 1. Install prerequisites:
+(Note, some packages may have slightly different version numbers, this should be ok for minor differences.)
+~~~
+sudo apt-get install build-essential
+sudo apt-get install qt5-qmake
+sudo apt-get install qt5-default
+sudo apt-get install libqt5core5a
+sudo apt-get install qtbase5-dev
+sudo apt-get install libqt5serialport5 libqt5serialport5-dev
+sudo apt-get install libqcustomplot1.3 libqcustomplot-doc libqcustomplot-dev
+sudo apt-get install git 
+~~~
+optional for those that want to work on the code using the QT Creator IDE: 
+~~~
+sudo apt-get install qtcreator qtcreator-doc
+~~~
+
+### 2. Clone wfview to a local directory on your computer:
+~~~ 
+cd ~/Documents
+git clone https://gitlab.com/eliggett/wfview.git
+~~~
+
+### 3. Create a build directory, compile, and install:
+~~~
+mkdir build
+cd build
+qmake ../wfview/wfview.pro
+make -j
+sudo ./install.sh
+~~~
+
+### 4. You can now launch wfview, either from the terminal or from your desktop environment. If you encounter issues using the serial port, run the following command: 
+~~~
+sudo chown $USER /dev/ttyUSB*
+~~~
+

README.md

@@ -29,12 +29,8 @@ wfview is copyright 2017-2020 Elliott H. Liggett. All rights reserved. wfview so
 * QT Creator for building, designing, and debugging w/gdb
 
 ### Build directions:
-1. clone this repository into a new folder
-2. make a directory to build the code in (mkdir build)
-3. Run qmake to configure the build:
-  * cd build
-  * qmake ../wfview/wfview.pro
-4. Compile by running make.
+
+See [INSTALL.md](https://gitlab.com/eliggett/wfview/-/blob/master/INSTALL.md) for directions. 
 
 ### Rig setting:
 1. CI-V Baud rate: Auto