# 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.

# Rocs: an educational Graph Theory IDE

<img src="https://invent.kde.org/kde/rocs/raw/master/icons/128-apps-rocs.png" align="right"
     title="Rocs logo" width="96" height="96">

Rocs is a Graph Theory IDE for everybody interested in designing and analyzing
graph algorithms (e.g., lecturers, students, researchers). For all these users,
Rocs provides an easy to use visual data structure editor and a powerful
scripting engine to execute algorithms.

[Rocs at KDE.org](https://www.kde.org/applications/education/rocs).

## Features

- Canvas for Graph Drawing;
- IDE for Graph related Programming, using Javascript as its main language,
  plus the graph library;
- Data Structures are extensible from the scripting interface in Javascript,
  so you can do anything you want;
- Collection of example algorithms and graph types.

## Documentation

 - [Installation instructions](INSTALL.md)
 - [Packager instructions](README.packager.md)
 - [Developer instructions](README.developer.md)

# Outline

This readme file currently covers the following topics (further topics will be
included in the future):

* [Building](#Building)
* [Licensing](#Licensing)

## Building

Rocs uses `CMake` as its build system. Please refer to the `CMake` output to see
the list of needed packages and versions.

## Licenses

Rocs follows the
[KDE Licensing policy](https://community.kde.org/Policies/Licensing_Policy).

### Source Files

 All
`*.cpp`, `*.h`, and `*.cmake` source files are licensed under one of the
following licenses:

- GPL-2
- GPL-2+
- LGPL-2.1

It is a medium term goal to provide all sources under inside `src/` as GPL-2+
and all sources in `libgraphtheory/` as LGPL-2+.

### Documentation

The documentation files (to be found at: `doc/`) are licensed under GFDL-NIV-1.2+.

### Test Files

For the automatic unit tests, special test files are provided and are, due to
their license holders, under non GPL-compatible licenses.

These test files are only processed while executing the unit tests and can be
omitted if no unit tests or no unit tests for a specific plugin, respectively,
shall be executed:

- `libgraphtheory/fileformats/dot/autotests/testfiles/`: EPL-1.0
  For further information see
  `libgraphtheory/fileformats/dot/autotests/testfiles/README`.