libraries/atcore/README.md

0001 <!--
0002     SPDX-FileCopyrightText: AtCore Authors
0003     SPDX-License-Identifier: CC-BY-SA-4.0
0004 -->
0005 ![LOGO](https://invent.kde.org/kde/atcore/raw/master/testclient/atcore-gui.png)  AtCore - KDE Print Service for 3DPrinters
0006 ----
0007 OS   | Build Status
0008 :---:|:----:
0009 **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/)
0010 **Windows** | [![Build Status](https://binary-factory.kde.org/job/AtCore_Nightly_win64/badge/icon)](https://binary-factory.kde.org/job/AtCore_Nightly_win64/)
0011 **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/)
0012 **MacOs** | [![Build Status](https://binary-factory.kde.org/job/AtCore_Nightly_macos/badge/icon)](https://binary-factory.kde.org/job/AtCore_Nightly_macos/)
0013
0014
0015 AtCore is a API to manage the serial connection between the computer and 3D Printers.<br/>
0016 This project is licensed under [LGPL-2.1] or [LGPL-3.0] or [KDE Accepted LGPL].
0017
0018 ----
0019 ## Supported Firmwares
0020 Currenty the following firmwares are supported.
0021
0022  Firmware Name |Basic Use| Control SD
0023  :------------:|:-------:|:----------:
0024  Repetier      | YES     | YES
0025  Marlin        | YES     | YES
0026  Teacup        | YES     | NO
0027  APrinter      | YES     | NO
0028  SPrinter      | YES     | NO
0029  Smoothie      | YES     | NO
0030  GRBL          | YES     | NO
0031
0032 ## Building  Deploying  AtCore
0033  See: [Building and Deploying]
0034
0035 ## Importing AtCore in your CMakeList
0036 CMake should find AtCore and link it to MYAPP using the following in your CMakeLists
0037 ```CMake
0038 include (AtCore REQUIRED COMPONATES AtCore )
0039 include (AtCore REQUIRED COMPONATES AtCoreWidgets )
0040 ...
0041 target_link_libraries(MYAPP AtCore::AtCore AtCore::AtCoreWidgets ... )
0042 ```
0043
0044 ## Getting Involved
0045  - [IRC] - Libera Chat \#kde-atelier
0046  - [Telegram] - Atelier group
0047  - [Web] - Our web page
0048  - Report Bugs to our [Bug Tracker].
0049  - Support us by making a [Donation]
0050  - [Contribute] to AtCore.
0051
0052 [IRC]: https://web.libera.chat/
0053 [Telegram]: https://telegram.me/KDEAtelier
0054 [Bug Tracker]: https://bugs.kde.org/enter_bug.cgi?product=Atelier&component=AtCore
0055 [KDE]: https://www.kde.org
0056 [Web]: https://atelier.kde.org
0057 [LGPL-2.1]:https://www.gnu.org/licenses/old-licenses/lgpl-2.1.html
0058 [LGPL-3.0]:https://www.gnu.org/licenses/lgpl-3.0.html
0059 [KDE Accepted LGPL]:https://community.kde.org/Policies/Licensing_Policy#LicenseRef-KDE-Accepted-LGPL
0060 [Building and Deploying]: doc/build.md
0061 [Contribute]: CONTRIBUTING.md
0062 [Donation]:https://kde.org/donate/?app=atcore