diff --git a/README.md b/README.md --- a/README.md +++ b/README.md @@ -1,14 +1,54 @@ +# SerialPlot Small and simple software for plotting data from serial port. -# Dependencies -- Qt 5, including serialport module -- qwt 6.1 -- libudev-dev (required for QSerialPort) +## Dependencies +- Qt 5, including SerialPort module +- Qwt 6.1 + +## Building + +### Obtain Dependencies + +- Qt5 development packages +- Qt5 SerialPort module +- CMake +- Mercurial + +Under Ubuntu/Debian: +```sudo apt-get install qtbase5-dev libqt5serialport5-dev cmake mercurial``` + +### Download and Install Qwt + +[Qwt](http://qwt.sourceforge.net) is the library that provides +plotting widgets for SerialPlot. As of this moment there is no +appropriate version of Qwt in debian repositories. You will need to +download and build Qwt with Qt5 yourself. + +Download Qwt 6 from here: http://sourceforge.net/projects/qwt/files/ -# Known Issues +Follow these instructions to build and install: +http://qwt.sourceforge.net/qwtinstall.html#qwtinstall-unix + +Make sure that you have built the Qwt with Qt 5 not Qt 4. + +### Download and Build SerialPlot + +You can use Mercurial to download SerialPlot source code. Or you can +download it from here: +https://bitbucket.org/hyOzd/serialplot/downloads + + hg clone https://hyOzd@bitbucket.org/hyOzd/serialplot + cd serialplot + mkdir build && cd build + cmake .. + make + +You can also build with QtCreator IDE using `serialplot.pro` file. + +## Known Issues - Port error 13 happens when closing. This is a Qt issue. It's known - to not happen Qt 5.4.1 . + to not happen with Qt 5.4.1 . Not fatal. -# License +## License This software is licensed under GPLv3. See file COPYING for details.