Changeset View
Changeset View
Standalone View
Standalone View
README.md
1 | AtCore - KDE Print Service for 3DPrinters [![Build Status](https://build.kde.org/buildStatus/icon?job=atcore%20master%20kf5-qt5)](https://build.kde.org/job/atcore%20master%20kf5-qt5/) | 1 | ![Logo](testclient/AtCoreTest.png) AtCore - KDE Print Service for 3DPrinters | ||
---|---|---|---|---|---|
2 | ---- | ||||
3 | #### Build Status | ||||
4 | 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-master-win32/badge/icon)](https://binary-factory.kde.org/job/atcore-master-win32/) MacOs [![Build Status](https://binary-factory.kde.org/job/atcore-master-macos/badge/icon)](https://binary-factory.kde.org/job/atcore-master-macos/) 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/) | ||||
5 | | ||||
2 | ---- | 6 | ---- | ||
3 | 7 | | |||
4 | AtCore is a API to manage the serial connection between the computer and 3D Printers.<br/> | 8 | AtCore is a API to manage the serial connection between the computer and 3D Printers.<br/> | ||
5 | This project is under LGPL V2+, for more information read COPYING.TXT. | 9 | This project is under LGPL V2+, for more information read COPYING.TXT. | ||
6 | 10 | | |||
7 | ---- | 11 | ---- | ||
8 | ### AtCore is under development! Please have that in mind while testing! | 12 | ### AtCore is under development! Please have that in mind while testing! | ||
9 | ---- | 13 | ---- | ||
10 | ### Supported Firmwares | 14 | #### Supported Firmwares | ||
11 | - Repetier | 15 | - Repetier | ||
12 | - Marlin | 16 | - Marlin | ||
13 | - Teacup | 17 | - Teacup | ||
14 | - APrinter | 18 | - APrinter | ||
15 | - SPrinter | 19 | - SPrinter | ||
16 | - Smoothie | 20 | - Smoothie | ||
17 | - Grbl | 21 | - Grbl | ||
18 | --- | 22 | --- | ||
19 | ### Getting AtCore | 23 | #### Getting AtCore | ||
20 | 24 | | |||
21 | Install a Premade package for ArchLinux: | 25 | Install a Premade package for ArchLinux: | ||
22 | - AUR [atcore-git](https://aur.archlinux.org/packages/atcore-git/) | 26 | - AUR [atcore-git](https://aur.archlinux.org/packages/atcore-git/) | ||
23 | --- | 27 | --- | ||
24 | ### Building AtCore For Development | 28 | #### Building AtCore For Development | ||
25 | ##### Minimal Qt Version: 5.7 | 29 | ##### Minimal Qt Version: 5.7 | ||
26 | 30 | | |||
27 | Dependencies for AtCore: | 31 | Dependencies for AtCore: | ||
28 | - qt5-base | 32 | - qt5-base | ||
29 | - qt5-serialport | 33 | - qt5-serialport | ||
30 | - extra-cmake-modules | 34 | - extra-cmake-modules | ||
31 | 35 | | |||
32 | Extra Dependencies for Test GUI | 36 | Extra Dependencies for Test GUI | ||
33 | - qt5-charts | 37 | - qt5-charts | ||
34 | 38 | | |||
35 | Optional Dependencies | 39 | Optional Dependencies | ||
36 | - doxygen | 40 | - doxygen | ||
37 | 41 | | |||
38 | Build Switches | 42 | Build Switches | ||
39 | - -DBUILD_TEST_GUI = ( ON | OFF ) Build the test client (Default is ON) | 43 | - -DBUILD_TEST_GUI = ( ON | OFF ) Build the test client (Default is ON) | ||
44 | | ||||
40 | ---- | 45 | ---- | ||
41 | #### Building on Linux | 46 | #### Building on Linux | ||
42 | ```bash | 47 | ```bash | ||
43 | $ git clone https://github.com/KDE/atcore.git | 48 | $ git clone https://github.com/KDE/atcore.git | ||
44 | $ cmake -DCMAKE_INSTALL_PREFIX=$(qtpaths --install-prefix) -DCMAKE_INSTALL_LIBDIR=lib CMakeLists.txt | 49 | $ cmake -DCMAKE_INSTALL_PREFIX=$(qtpaths --install-prefix) -DCMAKE_INSTALL_LIBDIR=lib CMakeLists.txt | ||
45 | $ make | 50 | $ make | ||
46 | $ make install | 51 | $ make install | ||
47 | ``` | 52 | ``` | ||
▲ Show 20 Lines • Show All 65 Lines • ▼ Show 20 Line(s) | |||||
113 | ### Testing AtCore | 118 | ### Testing AtCore | ||
114 | 119 | | |||
115 | Testing is simple and will help us a lot. | 120 | Testing is simple and will help us a lot. | ||
116 | - Build / Install the testclient | 121 | - Build / Install the testclient | ||
117 | - Connect to your printer | 122 | - Connect to your printer | ||
118 | - Test the controls in the testclient | 123 | - Test the controls in the testclient | ||
119 | - Test Print Command | 124 | - Test Print Command | ||
120 | - Save your log and send it with errors | 125 | - Save your log and send it with errors | ||
126 | | ||||
121 | --- | 127 | --- | ||
122 | > **Note:** | 128 | > **Note:** | ||
123 | > For your test results to be helpful they must include the full log output. | 129 | > For your test results to be helpful they must include the full log output. | ||
130 | | ||||
124 | --- | 131 | --- | ||
125 | ### Getting in Touch | 132 | #### Getting in Touch | ||
126 | You can reach us via: <br/> | 133 | You can reach us via: <br/> | ||
127 | [IRC] - freenode #kde-atelier <br/> | 134 | [IRC] - freenode #kde-atelier <br/> | ||
128 | [Telegram] - KDE Atelier group <br/> | 135 | [Telegram] - KDE Atelier group <br/> | ||
129 | [Web] - Our web page | 136 | [Web] - Our web page | ||
130 | ### Bugs | 137 | #### Bugs | ||
131 | For any bug that you find it you can go on [KDE Bugs] system and report it. Please try to give all the information about the issue, and backtrace if you have one. | 138 | For any bug that you find it you can go on [KDE Bugs] system and report it. Please try to give all the information about the issue, and backtrace if you have one. | ||
132 | 139 | | |||
133 | [IRC]: https://webchat.freenode.net/ | 140 | [IRC]: https://webchat.freenode.net/ | ||
134 | [Telegram]: telegram.me/KDEAtelier | 141 | [Telegram]: telegram.me/KDEAtelier | ||
135 | [KDE Bugs]: https://bugs.kde.org/enter_bug.cgi?product=Atelier | 142 | [KDE Bugs]: https://bugs.kde.org/enter_bug.cgi?product=Atelier | ||
136 | [Web]: https://atelier.kde.org | 143 | [Web]: https://atelier.kde.org |