From d79f6e2295a296b316c4b3e25893fcca70b06bd7 Mon Sep 17 00:00:00 2001 From: Elliott Liggett Date: Sat, 14 Mar 2020 19:50:57 -0700 Subject: [PATCH] Added install directions. --- INSTALL.md | 39 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 39 insertions(+) create mode 100644 INSTALL.md diff --git a/INSTALL.md b/INSTALL.md new file mode 100644 index 0000000..fc6f9bf --- /dev/null +++ b/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* +~~~ +