diff --git a/doc/mainpage.md b/doc/mainpage.md index 82f582e..cc2990a 100644 --- a/doc/mainpage.md +++ b/doc/mainpage.md @@ -1,42 +1,52 @@ -# AtCore -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. - -### Building Deploying %AtCore - See: [Building and Deploying](build.md) - -### Supported Firmwares - - Repetier - - Marlin - - Teacup - - APrinter - - SPrinter - - Smoothie - - Grbl - -### Importing with CMake -CMake should find AtCore using the following in your CMakeLists +# %AtCore + +%AtCore is a API to manage the serial connection between the computer and 3D Printers. + +This project is under [LGPL-2.0]+. + +%AtCore is written by [KDE] members, + + - Chris Rizzitello + - Patrick José Pereira + - Lays Rodrigues
+ - Tomaz Canabrava + +## 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 ) ``` - -### Authors -Chris Rizzitello
-Patrick José Pereira
-Lays Rodrigues
-Tomaz Canabrava
- -### Getting in Touch -You can reach us via:
-[IRC] - freenode \#kde-atelier
-[Telegram] - 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. -### Getting Involved. -If you would like to join us please see our [contributing](contrib.md) page. + +## 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 -[Bugs]: https://bugs.kde.org/enter_bug.cgi?product=Atelier&component=AtCore -[Web]: https://ateler.kde.org +[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]:build.md +[Contribute]:contrib.md +[Donation]:https://kde.org/donate/?app=atcore