From 54e2f7d2eca454c119d174b287d6336e0559aec1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=D0=9F=D0=B5=D0=BB=D0=B8=D0=BF=D0=B5=D0=BD=D0=BA=D0=BE=20?= =?UTF-8?q?=D0=98=D0=B2=D0=B0=D0=BD?= Date: Sat, 25 Apr 2020 19:44:43 +0300 Subject: [PATCH] =?UTF-8?q?=D0=98=D0=B7=D0=BC=D0=B5=D0=BD=D0=B8=D1=82?= =?UTF-8?q?=D1=8C=20'README.md'?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 41 +++++++++++++++++++++++++++++++++++++++++ README.txt | 18 ------------------ 2 files changed, 41 insertions(+), 18 deletions(-) create mode 100644 README.md delete mode 100644 README.txt diff --git a/README.md b/README.md new file mode 100644 index 0000000..60b9506 --- /dev/null +++ b/README.md @@ -0,0 +1,41 @@ +# Main SHS SDK libraries repo +## Introduction +This repo contains PIP, QAD and derived projects: +* cd_utils - PIP-based client/server library for read, transmit and use custom structures of coefficients +* qcd_utils - Qt bindings to CDUtils and "CD Pult" executable - full-featured CD client +* piqt - helpers to convert PIP <-> Qt types +* piqt_utils - Gui libraries and executables to edit PIConnection configs and watch PIIntrospection +* qglview - old Qt-base OpenGL engine +* qglengine - new Qt-base OpenGL engine +## Compile +This repo can be compile with GCC/MinGW/Clang, for Qt 4/5. + +If there is no Qt found, builds only PIP and cd_utils. + +CMake options: +* **LIB** - if 1 then install to system directories: MinGW on Windows, /usr/local on Linux/MacOS, ${ANDROID_SYSTEM_LIBRARY_PATH} on Android. If 0 then install to ${CMAKE_INSTALL_PREFIX}. Enabled by default +* **UTILS** - build or not executable utilites, enabled by default +* **DESIGNER_PLUGINS** - build or not Qt Designer plugins, enabled by default +* **QGLVIEW** - build or not QGLView, disabled by default +* **QGLENGINE** - build or not QGLEngine, disabled by default +## Windows scripts +Build steps for i686 architecture: +1. unzip mingw.7z to C:\mingw +2. unzip qt.7z to C:\qt +3. download and install cmake from https://cmake.org/download/ +4. Prepare environment + - set prefix for mingw e.g.: for C:\mingw\7_1_x32\ + set SDK_MINGW_DIR=C:\mingw\7_1_x + - set prefix for Qt5 e.g.: for C:\qt\qt5120_win32\ + set SDK_QT5_DIR=C:\qt\qt5120_win + - set SDK_CMAKE_DIR=C:\cmake +5. run make_libs32.bat + +Build steps for amd64 architecture: + -- follow previos steps, but replace '32' to '64' + +Build steps for both architectures: + -- follow previos steps, but on '4' state run make_libs_all.bat + ## Non-Windows scripts + Script "make_libs.sh" compile and install SDK for current environment, e.g. + `./make_libs.sh -j4` \ No newline at end of file diff --git a/README.txt b/README.txt deleted file mode 100644 index 1395f22..0000000 --- a/README.txt +++ /dev/null @@ -1,18 +0,0 @@ -Build steps for i686 architecture: -1. unzip mingw.7z to C:\mingw -2. unzip qt.7z to C:\qt -3. download and install cmake from https://cmake.org/download/ -2. Prepare environment - - set prefix for mingw e.g.: for C:\mingw\7_1_x32\ - set SDK_MINGW_DIR=C:\mingw\7_1_x - - set prefix for Qt5 e.g.: for C:\qt\qt5120_win32\ - set SDK_QT5_DIR=C:\qt\qt5120_win - - set SDK_CMAKE_DIR=C:\cmake -4. run make_libs32.bat - -Build steps for amd64 architecture: - -- follow previos steps, but replace '32' to '64' - -Build steps for both architectures: - -- follow previos steps, but on '4' state run make_libs_all.bat - \ No newline at end of file