utilities/atelier/README.md

0001 Atelier - KDE Printer Host for 3DPrinters
0002 ---
0003
0004 Atelier has the goal to be the best open source printer host to control
0005 3DPrinters from your computer in any platform: Linux, Windows and MacOs.
0006 This project is under GPL V3, for more information read COPYING.GPL3.
0007
0008 Atelier depends on [AtCore](https://invent.kde.org/libraries/atcore), the API to manage the serial connection between the computer and 3D Printers/CNC.
0009 AtCore is also on development by team Atelier.
0010
0011 ---
0012 ### AtCore Supported Firmwares
0013  - Repetier
0014  - Marlin
0015  - Teacup
0016  - APrinter
0017  - SPrinter
0018  - Smoothie
0019  - Grbl
0020 ---
0021 ### Atelier Features
0022 Atelier gives to you a user friendly interface to control and manage your printer.
0023
0024 - 3DView: So load and see your GCode File
0025 - Temperatures Timeline: A real time graphic to monitor your bed and hotend temperatures
0026 - Log: You can log everything that comes and go from your printer in a file to check if everything is ok.
0027 - GCode Editor: A complete editor inside Atelier to make editions on your gcode file.
0028
0029 > Atelier is under development, beta version comming out soon.
0030 ---
0031 #### Atelier is powered by [Qt](qt.io) and [KDE Frameworks](https://api.kde.org/frameworks/)
0032 ---
0033 ### Build Atelier for Development
0034 ##### Minimal Qt Version: 5.7
0035
0036 Dependencies for Atelier:
0037  - Build and install AtCore, see AtCore README to check the build information.
0038  Qt Libs
0039  - QtBase
0040  - QtCharts
0041  - QtSerialPort
0042  - Qt3D
0043
0044  KDE API's
0045  - KI18n
0046  - KXMLGui
0047  - KConfigWidgets
0048  - KTextEditor
0049  - Extra-Cmake-Modules
0050  ----
0051  #### Building on Linux
0052  ```bash
0053  $ git clone https://invent.kde.org/utilities/atelier.git
0054  $ cmake atelier
0055  $ make
0056  $ make install
0057  ```
0058 ---
0059 ### Getting in Touch
0060 You can reach us via: <br/>
0061 [IRC] - Libera Chat #kde-atelier <br/>
0062 [Telegram] - KDE Atelier group <br/>
0063 [Mail List] - Our Mail List <br/>
0064 ---
0065 ### Bugs
0066 Please report any bugs to our [Bug Tracker]. Please remember to include as much information about your issue and provide a backtrace if possible.
0067
0068 [IRC]: https://web.libera.chat/
0069 [Telegram]: telegram.me/KDEAtelier
0070 [Bug Tracker]: https://bugs.kde.org/enter_bug.cgi?product=Atelier
0071 [Mail List]: atelier@kde.org