Commit 6ccda5f4 authored by Chris Rizzitello's avatar Chris Rizzitello

Update Documentation

parent 36fb1828
![Logo](testclient/atcore-gui.png) AtCore - KDE Print Service for 3DPrinters
![LOGO](https://invent.kde.org/kde/atcore/raw/master/testclient/atcore-gui.png) AtCore - KDE Print Service for 3DPrinters
----
OS | Build Status
:---:|:----:
......@@ -9,7 +9,7 @@ OS | Build Status
AtCore is a API to manage the serial connection between the computer and 3D Printers.<br/>
This project is under LGPL V2+, for more information read ![COPYING.TXT](COPYING.TXT).
This project is under [LGPL-2.0]+.
----
## Supported Firmwares
......@@ -29,7 +29,7 @@ Currenty the following firmwares are supported.
See: [Building and Deploying]
## Importing AtCore in your CMakeList
CMake should find %AtCore and link it to MYAPP using the following in your CMakeLists
CMake should find AtCore and link it to MYAPP using the following in your CMakeLists
```CMake
include (AtCore REQUIRED COMPONATES AtCore )
include (AtCore REQUIRED COMPONATES AtCoreWidgets )
......@@ -46,11 +46,11 @@ target_link_libraries(MYAPP AtCore::AtCore AtCore::AtCoreWidgets ... )
- [Contribute] to AtCore.
[IRC]: https://webchat.freenode.net/
[Telegram]: telegram.me/KDEAtelier
[Telegram]: https://telegram.me/KDEAtelier
[Bug Tracker]: https://bugs.kde.org/enter_bug.cgi?product=Atelier&component=AtCore
[KDE]:https://www.kde.org
[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
[Building and Deploying]: doc/build.md
[Contribute]: doc/contrib.md
[Donation]:https://kde.org/donate/?app=atcore
......@@ -150,7 +150,7 @@ INLINE_INHERITED_MEMB = NO
# shortest path that makes the file name unique will be used
# The default value is: YES.
FULL_PATH_NAMES = YES
FULL_PATH_NAMES = NO
# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
# Stripping is only done if one of the specified strings matches the left-hand
......@@ -790,7 +790,10 @@ WARN_LOGFILE =
# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
# Note: If this tag is empty the current directory is searched.
INPUT = mainpage.md contrib.md build.md ../src
INPUT += mainpage.md \
contrib.md \
build.md \
../src
# This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
......@@ -926,7 +929,7 @@ EXAMPLE_RECURSIVE = NO
# that contain images that are to be included in the documentation (see the
# \image command).
IMAGE_PATH =
IMAGE_PATH =
# The INPUT_FILTER tag can be used to specify a program that doxygen should
# invoke to filter for each input file. Doxygen will invoke the filter program
......@@ -2147,12 +2150,6 @@ EXTERNAL_GROUPS = YES
EXTERNAL_PAGES = YES
# The PERL_PATH should be the absolute path and name of the perl script
# interpreter (i.e. the result of 'which perl').
# The default file (with absolute path) is: /usr/bin/perl.
PERL_PATH = /usr/bin/perl
#---------------------------------------------------------------------------
# Configuration options related to the dot tool
#---------------------------------------------------------------------------
......@@ -2166,15 +2163,6 @@ PERL_PATH = /usr/bin/perl
CLASS_DIAGRAMS = YES
# You can define message sequence charts within doxygen comments using the \msc
# command. Doxygen will then run the mscgen tool (see:
# http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the
# documentation. The MSCGEN_PATH tag allows you to specify the directory where
# the mscgen tool resides. If left empty the tool is assumed to be found in the
# default search path.
MSCGEN_PATH =
# You can include diagrams made with dia in doxygen documentation. Doxygen will
# then run dia to produce the diagram and insert it in the documentation. The
# DIA_PATH tag allows you to specify the directory where the dia binary resides.
......
# Building And Deploying %AtCore
Building %AtCore is broken up into to main steps Configuration and Building. Deploying %AtCore is also covered here.
# Building And Deploying AtCore
Building AtCore is broken up into to main steps Configuration and Building. Deploying AtCore is also covered here.
## Configuration
In order to configure your build you will need [cmake] and [extra-cmake-modules].
%AtCore Build Options Are:
Build Options Are:
- -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)
......@@ -29,7 +29,7 @@ make
```
## Dependencies
In addition to a working development enviroment for your system you will need the following to build %AtCore
In addition to a working development enviroment for your system you will need the following to build AtCore
- qt5-base
- qt5-serialport
- qt5-widgets
......@@ -62,8 +62,8 @@ ninja install
```
Then Download and install [Qt]
## Deploying %AtCore
After you build you may wish to deploy atcore on your system for use
## Deploying AtCore
After you build you may wish to deploy AtCore on your system for use
### Linux
From the build dir the command below to install atcore with its plugins to the system (assuming cmake used above)
```
......
# Contributing To AtCore
%AtCore is an open source project and all open source projects need contrubitors. Thank you for taking the time to read this document and Thank you for your contributions to the project.
AtCore is an open source project and all open source projects need contrubitors. Thank you for taking the time to read this document and Thank you for your future contributions to this project.
----
## Prerequisites
In order to contrbute directly to %AtCore you will need to have a [KDE Identity]. You should also install [arcanist] on your system since it will make creating revisions for
code review much easier.You may wish to join us on [IRC] or [Telegram]
In order to contrbute directly to AtCore you will need to have a [KDE Identity]. You should create a fork on [KDE Invent] to work within. You may wish to join us on [IRC] or [Telegram].
## Ways you can contribute
There are several ways you can contribute
- Submit or Help to confirm bugs in our [Bug Tracker].
- Find Errors in the documentation or help to otherwise improve it
- Help users solve their issues
- Help to review Code (Watch the project on [KDE Invent])
- Commit new code or code to fix bugs.
## General Contribution Workflow
The Following Is the General work flow for most contrubitions
- Create changes on your local fork in a new branch
- When your ready to submit your change create a Merge Request on [KDE Invent]
- Wait for review
- Update your commits with any changes, and update your Merge Request after.
- Mark all your "Issues" resolved in your MR.
- Repeat Review / Update until changes is accepted.
- A Maintainer will Merge when the changes is ready.
### General Coding Guidelines
The following guidelines apply to all submited code.
......@@ -19,22 +35,27 @@ The following guidelines apply to all submited code.
- Auto should not be used if the type is not explict.
- Doxygen comments should be created/updated with code.
- Objects should have logical varible and function names
- Code should alway be readable ,comment your code.
- Code should always be readable, comment your code when it makes sense.
### Commit Guidelines
Keeping a clean project history requires that we take care when choosing how we will commit our code.Consider the following when creating commits. ALL COMMITS MUST BE REVIEWED BEFORE PUSHING TO MASTER.
Keeping a clean project history requires that we take care when choosing how we will commit our code. Consider the following when creating commits. ALL COMMITS MUST BE REVIEWED BEFORE PUSHING TO MASTER.
- Follow the [KDE commit guidelines]
- Reviewers: rizzitello, patrickelectric, laysrodrigues, tcanabrava
- Be sure to make things "done" in phabricator.
- Update your revisions with `arc diff --update <diff number>`
- Be sure to make any review issues as resolved.
- Keep your base upto date.
- Amend your local commits to fix review issues.
- Always Ammend commits to update them
- Never fix a commit with another commit.
- Update your commits with `git commit --amend`
- Update your MR with `git push --force`
- Revisions require a majority acceptance rate before landing
- Land your code with `arc land <branch>`
- Your Merge Request will be merged when your code when its ready
[IRC]: https://webchat.freenode.net/
[Telegram]: telegram.me/KDEAtelier
[Telegram]: https://telegram.me/KDEAtelier
[Bug Tracker]: https://bugs.kde.org/enter_bug.cgi?product=Atelier&component=AtCore
[KDE Identity]: https://identity.kde.org/
[arcanist]:https://secure.phabricator.com/book/phabricator/article/arcanist/
[KDE style guidelines]:https://community.kde.org/Policies/Kdelibs_Coding_Style
[KDE commit guidelines]:https://community.kde.org/Policies/Commit_Policy
[KDE Invent]: https://invent.kde.org
[KDE style guidelines]: https://community.kde.org/Policies/Kdelibs_Coding_Style
[KDE commit guidelines]: https://community.kde.org/Policies/Commit_Policy
# %AtCore
%AtCore is a API to manage the serial connection between the computer and 3D Printers.
# AtCore - KDE Print Service for 3DPrinters
AtCore is a API to manage the serial connection between the computer and 3D Printers.<br/>
This project is under [LGPL-2.0]+.
%AtCore is written by [KDE] members,
- Chris Rizzitello <rizzitello@kde.org>
- Patrick José Pereira <patrickjp@kde.org>
- Lays Rodrigues <lays.rodrigues@kde.org>
- Tomaz Canabrava <tcanabrava@kde.org>
----
## Supported Firmwares
Currenty the following firmwares are supported.
......@@ -24,11 +17,11 @@ Currenty the following firmwares are supported.
Smoothie | YES | NO
GRBL | YES | NO
## Building Deploying %AtCore
## Building Deploying AtCore
See: [Building and Deploying]
## Importing %AtCore in your CMakeList
CMake should find %AtCore and link it to MYAPP using the following in your CMakeLists
## Importing AtCore in your CMakeList
CMake should find AtCore and link it to MYAPP using the following in your CMakeLists
```CMake
include (AtCore REQUIRED COMPONATES AtCore )
include (AtCore REQUIRED COMPONATES AtCoreWidgets )
......@@ -42,14 +35,14 @@ target_link_libraries(MYAPP AtCore::AtCore AtCore::AtCoreWidgets ... )
- [Web] - Our web page
- Report Bugs to our [Bug Tracker].
- Support us by making a [Donation]
- [Contribute] to %AtCore.
- [Contribute] to AtCore.
[IRC]: https://webchat.freenode.net/
[Telegram]: telegram.me/KDEAtelier
[Telegram]: https://telegram.me/KDEAtelier
[Bug Tracker]: https://bugs.kde.org/enter_bug.cgi?product=Atelier&component=AtCore
[KDE]:https://www.kde.org
[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
[Building and Deploying]: build.md
[Contribute]: contrib.md
[Donation]:https://kde.org/donate/?app=atcore
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment