File: README.developer.md

package info (click to toggle)
rocs 4:20.12.1-1
  • links: PTS, VCS
  • area: main
  • in suites:
  • size: 7,692 kB
  • sloc: cpp: 14,726; javascript: 784; xml: 598; makefile: 13; sh: 12
file content (36 lines) | stat: -rw-r--r-- 1,123 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
# Developer Guidelines

## First Steps

1. Read the API high-level/overview information at:
   - [`libgraphtheory`](libgraphtheory)
   - [`src`](src)
2. Compile:
   - have a look at the `CMake` output!
3. Run Tests and Run Application:
   - `make tests`

## API Documentation

The Rocs API is reasonable good documentation in most parts of Rocs,
especially in the RocsCore library. You can either
[create the doxygen files by hand](https://techbase.kde.org/Development/Tools/apidox)
or use the [nightly updated references](https://api.kde.org//4.x-api/kdeedu-apidocs/rocs/html/index.html).

## Project ToDo List

Please read/update the
[Community Wiki Page](https://community.kde.org/KDEEdu/Rocs/Todo).

## Coding Styles

The coding styles are (slowly) converging to the
[KDE-libs coding styles](https://community.kde.org/Policies/Kdelibs_Coding_Style).

## Mailing Lists

Rocs is part of KDE Edu, which has the 
[kde-edu@kde.org](mailto:kde-edu@kde.org) mailing list.

For technical discussion, which are only within the scope of the Rocs project,
we have the [rocs-devel@kde.org](mailto:rocs-devel@kde.org) mailing list.