diff --git a/README.md b/README.md index 3f3cac5..fde8bf1 100644 --- a/README.md +++ b/README.md @@ -1,147 +1,48 @@ -![Logo](testclient/AtCoreTest.png) AtCore - KDE Print Service for 3DPrinters ----- -#### 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-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/) - +![Logo](testclient/atcore-gui.png) AtCore - KDE Print Service for 3DPrinters ---- +**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/) AtCore is a API to manage the serial connection between the computer and 3D Printers.
-This project is under LGPL V2+, for more information read COPYING.TXT. +This project is under LGPL V2+, for more information read ![COPYING.TXT](COPYING.TXT). ---- -### AtCore is under development! Please have that in mind while testing! ----- -#### Supported Firmwares - - Repetier - - Marlin - - Teacup - - APrinter - - SPrinter - - Smoothie - - Grbl - --- -#### Getting AtCore - -Install a Premade package for ArchLinux: - - AUR [atcore-git](https://aur.archlinux.org/packages/atcore-git/) ---- -#### Building AtCore For Development -##### Minimal Qt Version: 5.7 - -Dependencies for AtCore: - - qt5-base - - qt5-serialport - - extra-cmake-modules - -Extra Dependencies for Test GUI - - qt5-widgets - - qt5-charts - -Optional Dependencies - - doxygen - - git - -Build Switches - - -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) - ----- -#### Building on Linux -```bash -$ git clone https://github.com/KDE/atcore.git -$ cmake -DCMAKE_INSTALL_PREFIX=$(qtpaths --install-prefix) -DCMAKE_INSTALL_LIBDIR=lib CMakeLists.txt -$ make -$ make install -``` ----- -#### Building on Windows - -For Windows build you need to set up [Craft](https://community.kde.org/Guidelines_and_HOWTOs/Build_from_source/Windows) -It's tricky, but with all the last changes in half an hour you can have the setup done. -Remember, it's easier if you have Python3.6 or higher installed. -After you have the Craft environment setup do: -```powershell -craft atcore -``` -This will dowload all Qt and KDE libraries needed and compile Atcore. -For running, inside the prompt call: -```powershell -AtCoreTest -``` -For debugging run: -```powershell -craft vsd -vsd AtCoreTest -``` -This will give you feedback on the prompt to check what is happening. - -For packing: -```powershell -craft --package atcore -``` -At C:/KDE/craft/tmp you will find the installer. - -#### Building on Mac OS -Install: - - Git - - QtCreator - - XCode - - CMake - - Extra-Cmake-Modules via [Craft](https://community.kde.org/Guidelines_and_HOWTOs/Build_from_source/Mac) -Open a terminal and run: -```bash -$ git clone https://github.com/KDE/atcore.git -``` -Now you open QtCreator and open AtCore like project selecting the CMakeLists.txt on the root of AtCore folder. -Setup your development environment: - - Set your CMAKE_C_COMPILER to /usr/bin/cc - - Set your ECM_DIR to your ECM install directory. - -Now you can build AtCore. -After build do: - - Copy the plugins files from /src/plugins/*.dylib to AtCoreTest.app/Contents/MacOS/plugins - - Run macdeployqt on the app - -### Docker -We have a docker container within this project. To use it on your Docker environment just pull it: -```bash -$ docker pull lays147/atcore -``` -To run it on Linux: -```bash -$ xhost: local:root -$ docker run --rm -it -v /tmp/.X11-unix:/tmp/.X11-unix -e DISPLAY --device DEVICE lays147/atcore:latest -``` - -You need to use the --device option to give the container access to your printer. It must point to the printers serial device. -Overriding DEVICE value to the port of your printer. -
-Example: ```--device /dev/ttyUSB0``` - -### Testing AtCore - -Testing is simple and will help us a lot. - - Build / Install the testclient - - Connect to your printer - - Test the controls in the testclient - - Test Print Command - - Save your log and send it with errors - ---- - > **Note:** - > For your test results to be helpful they must include the full log output. - ---- -#### Getting in Touch -You can reach us via:
-[IRC] - freenode #kde-atelier
-[Telegram] - KDE Atelier group
-[Web] - Our web page -#### Bugs -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. +## 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 using the following in your CMakeLists +```CMake +include (AtCore REQUIRED COMPONATES AtCore ) +``` + +## 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]: telegram.me/KDEAtelier -[KDE Bugs]: https://bugs.kde.org/enter_bug.cgi?product=Atelier&component=AtCore +[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 +[Donation]:https://kde.org/donate/?app=atcore +