diff --git a/README.md b/README.md index 8c0d1a9..6ff00c0 100644 --- a/README.md +++ b/README.md @@ -1,56 +1,56 @@ ![LOGO](https://invent.kde.org/kde/atcore/raw/master/testclient/atcore-gui.png) AtCore - KDE Print Service for 3DPrinters ---- OS | Build Status :---:|:----: -**Linux** | [![Build Status](https://build.kde.org/job/Extragear%20atcore%20kf5-qt5%20SUSEQt5.9/badge/icon)](https://build.kde.org/job/Extragear%20atcore%20kf5-qt5%20SUSEQt5.9/) -**Windows** | [![Build Status](https://binary-factory.kde.org/job/AtCore_Nightly_win32/badge/icon)](https://binary-factory.kde.org/job/AtCore_Nightly_win32/) -**FreeBSD** | [![Build Status](https://build.kde.org/job/Extragear%20atcore%20kf5-qt5%20FreeBSDQt5.9/badge/icon)](https://build.kde.org/job/Extragear%20atcore%20kf5-qt5%20FreeBSDQt5.9/) +**Linux** | [![Build Status](https://build.kde.org/job/Extragear/job/atcore/job/kf5-qt5%20SUSEQt5.14/badge/icon)](https://build.kde.org/job/Extragear/job/atcore/job/kf5-qt5%20SUSEQt5.14/) +**Windows** | [![Build Status](https://binary-factory.kde.org/job/AtCore_Nightly_win64/badge/icon)](https://binary-factory.kde.org/job/AtCore_Nightly_win64/) +**FreeBSD** | [![Build Status](https://build.kde.org/job/Extragear/job/atcore/job/kf5-qt5%20FreeBSDQt5.14/badge/icon)](https://build.kde.org/job/Extragear/job/atcore/job/kf5-qt5%20FreeBSDQt5.14/) **MacOs** | [![Build Status](https://binary-factory.kde.org/job/AtCore_Nightly_macos/badge/icon)](https://binary-factory.kde.org/job/AtCore_Nightly_macos/) AtCore is a API to manage the serial connection between the computer and 3D Printers.
This project is under [LGPL-2.0]+. ---- ## Supported Firmwares Currenty the following firmwares are supported. Firmware Name |Basic Use| Control SD :------------:|:-------:|:----------: Repetier | YES | YES Marlin | YES | YES Teacup | YES | NO APrinter | YES | NO SPrinter | YES | NO Smoothie | YES | NO GRBL | YES | NO ## Building Deploying AtCore See: [Building and Deploying] ## Importing AtCore in your CMakeList CMake should find AtCore and link it to MYAPP using the following in your CMakeLists ```CMake include (AtCore REQUIRED COMPONATES AtCore ) include (AtCore REQUIRED COMPONATES AtCoreWidgets ) ... target_link_libraries(MYAPP AtCore::AtCore AtCore::AtCoreWidgets ... ) ``` ## Getting Involved - [IRC] - freenode \#kde-atelier - [Telegram] - Atelier group - [Web] - Our web page - Report Bugs to our [Bug Tracker]. - Support us by making a [Donation] - [Contribute] to AtCore. [IRC]: https://webchat.freenode.net/ [Telegram]: https://telegram.me/KDEAtelier [Bug Tracker]: https://bugs.kde.org/enter_bug.cgi?product=Atelier&component=AtCore [KDE]: https://www.kde.org [Web]: https://atelier.kde.org [LGPL-2.0]:https://www.gnu.org/licenses/old-licenses/lgpl-2.0.html [Building and Deploying]: doc/build.md -[Contribute]: doc/contrib.md +[Contribute]: CONTRIBUTING.md [Donation]:https://kde.org/donate/?app=atcore diff --git a/doc/build.md b/doc/build.md index 16e86c5..5a4b1bb 100644 --- a/doc/build.md +++ b/doc/build.md @@ -1,102 +1,102 @@ # Building And Deploying AtCore Building AtCore is broken up into to main steps Configuration and Building. Deploying AtCore is also covered here. ## Configuration In order to configure your build you will need [cmake] and [extra-cmake-modules]. Build Options Are: - -DBUILD_GUI = ( ON | OFF ) Build the test client (Default is OFF) - -DBUILD_DOCS = (ON | OFF ) Build the Documentation (Default is OFF) - -DBUILD_TESTS = ( ON | OFF ) Build and Run Unittests (Default is OFF) - -DDEPLOY_PLUGINS_WITH_BINARY ( ON | OFF ) Deploy the plugins to bin/plugins (Default is OFF, Turn on for win/mac) Recommended CMake Command Linux ``` cmake -DCMAKE_INSTALL_PREFIX=/usr -DCMAKE_INSTALL_LIBDIR=lib CMakeLists.txt ``` Mac OS/ Windows ``` cmake -DDEPLOY_PLUGINS_WITH_BINARY=ON CMakeLists.txt ``` ## Building After Configuring you Should be able to run make to build all targets. ``` make ``` ## Dependencies In addition to a working development enviroment for your system you will need the following to build AtCore - qt5-base - qt5-serialport - qt5-widgets - qt5-charts Building The Documentation adds the following dependency: - [doxygen] ### Installing Dependencies on Windows and Mac OS #### Mac Os Mac Os users could use [homebrew] to install both cmake and cmake-extra-modules using. ``` brew update brew install cmake brew tap KDE-mac/kde; brew install kf5-extra-cmake-modules ``` Then can download and install [Qt] #### Windows Windows users could install [chocolatey] and do something like ``` choco install cmake choco install ninja git clone -q git://anongit.kde.org/extra-cmake-modules.git cd extra-cmake-modules cmake -G "Ninja" . -DCMAKE_INSTALL_PREFIX= ninja install ``` Then Download and install [Qt] ## Deploying AtCore After you build you may wish to deploy AtCore on your system for use ### Linux From the build dir the command below to install atcore with its plugins to the system (assuming cmake used above) ``` sudo make install ``` ### Finding Plugins AtCore will check each directory below for plugins. 1. QApplication::applicationDirPath/plugins 2. QApplication::applicationDirPath/AtCore 3. QApplication::applicationDirPath/../PlugIns/AtCore 4. INSTALL_PREFIX/KDE_PLUGIN_DIR/AtCore 5. QT_Plugin_Path/AtCore 6. KDE_PLUGIN_DIR/AtCore 7. BUILDDIR for plugins. For Locations starting with 'QApplication::applicationDirPath' atcore will look next to the binary using atcore. Usually this is in a directory next to the program ``` atcore_test_GUI\atcore-gui.exe atcore_test_GUI\AtCore.dll atcore_test_GUI\plugins\repetier.dll ``` But on Mac OS this is in the app bundle ``` atcore-gui.app/Contents/MacOS/atcore-gui atcore-gui.app/Contents/MacOS/AtCore.dylib atcore-gui.app/Contents/MacOS/plugins/repetier.dylib ``` [Qt]:https://www.qt.io -[doxygen]:http://www.stack.nl/~dimitri/doxygen/ +[doxygen]:http://www.doxygen.nl/ [cmake]:https://cmake.org/ [extra-cmake-modules]:https://cgit.kde.org/extra-cmake-modules.git/tree [homebrew]:https://brew.sh/ [chocolatey]:https://chocolatey.org/