diff --git a/README.md b/README.md new file mode 100644 index 0000000..b8fbf2e --- /dev/null +++ b/README.md @@ -0,0 +1,29 @@ +# Intro +This is the GUI Interface to a proprietary server that interfaces with speech recognition backends. + +![GUI Main-Window](https://media.atlantishq.de/qt_client.png) + +# Build on Linux +This is a qt-creator project and can be imported as such. To build for Windows (on Linux) you need [MXE](https://github.com/mxe/mxe.git). + +To download and compile MXE and dependencies: + + git clone https://github.com/mxe/mxe.git + cd mxe && make qtbase + make -j 4 qt qt5 MXE_TARGETS='x86_64-w64-mingw32.shared i686-w64-mingw32.shared x86_64-w64-mingw32.static i686-w64-mingw32.static' + make qtbase + +Setup the actual compilation enviroment: + + MXE_ROOT=/path/to/mxe/root/ + export PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:$MXE_ROOT/usr/bin + $MXE_ROOT/usr/bin/i686-w64-mingw32.static-qmake-qt5 + make + +Also check the ``cross_compile.sh`` file in this project. + +# Build on Windows +If you want to build this project on windows, you need change the way this project determines some of it's defines in the project file. + +# Build for Mac +This project does not currently support Mac.