diff --git a/INSTALL.md b/INSTALL.md index 01a8fc94..f24618cd 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -1,17 +1,19 @@ # Installing Rocs ## From packages All major Linux distributions (and also the KDE on Windows -Project) ship precompiled versions of the latest release Rocs. +Project and FreeBSD) ship precompiled versions of the latest release Rocs. [Rocs installation commands](https://pkgs.org/download/rocs) ## From source Alternatively, here are generic installation instructions from source: -1. Download the released `tar.gz` source files from http://download.kde.org - - Alternatively clone the git repository at https://projects.kde.org/projects/kde/kdeedu/rocs. +1. Get the source in one of these ways: + - Download the released `tar.gz` source files from https://download.kde.org/ + - Download a specific release, e.g. https://download.kde.org/stable/applications/19.04.2/src/ + - Clone the git repository at https://invent.kde.org/kde/rocs.git 2. [Configure your system](http://techbase.kde.org/Projects/Edu/Rocs). -3. Start Rocs by running the `rocs` binary on a terminal. \ No newline at end of file +3. Start Rocs by running the `rocs` binary on a terminal. diff --git a/Mainpage.dox b/Mainpage.dox index d45779f5..abed3e52 100644 --- a/Mainpage.dox +++ b/Mainpage.dox @@ -1,25 +1,22 @@ /*! * @mainpage The Rocs API Reference * * * The KDE online class reference for the current development version of * Rocs. * * Rocs is divided into the following modules: * - * - Application. + * - Application. * The Rocs Graph IDE. * - * - Rocs Core Library. + * - Graph Theory Library. * Core library for definition and simulation of data structures. * - * - Rocs Visual Editor. - * Visual editor for modifying and display of data structures. - * * @b Follow the development of this application and its libraries. Please consider joining the * Rocs Development Mailing List. */ // DOXYGEN_NAME="Rocs" // DOXYGEN_ENABLE=YES // DOXYGEN_SET_WARN_LOGFILE=doxygen.log diff --git a/README.developer.md b/README.developer.md index f582417b..f0ac2d6d 100644 --- a/README.developer.md +++ b/README.developer.md @@ -1,36 +1,36 @@ # Developer Guidelines ## First Steps 1. Read the API high-level/overview information at: - [`libgraphtheory`](libgraphtheory) - - [`stc`](src) + - [`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](http://techbase.kde.org/Development/Tools/apidox) -or use the nightly updated references at https://api.kde.org. +[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](http://community.kde.org/KDEEdu/Rocs/Todo). +[Community Wiki Page](https://community.kde.org/KDEEdu/Rocs/Todo). ## Coding Styles The coding styles are (slowly) converging to the -[KDE-libs coding styles](http://techbase.kde.org/Policies/Kdelibs_Coding_Style). +[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. diff --git a/README.md b/README.md index 2c8e3ce1..6ccfc54b 100644 --- a/README.md +++ b/README.md @@ -1,23 +1,26 @@ # Rocs: an educational Graph Theory IDE + 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 it's main language, - plus the graph library -- Data Structures are extensible from the scripting interface, so you can do - anything you want. +- 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 - -[Installation instructions](INSTALL.md) \ No newline at end of file + - [Installation instructions](INSTALL.md) + - [Packager instructions](README.packager.md) + - [Developer instructions](README.developer.md) diff --git a/README.packager.md b/README.packager.md index 42c67c16..5f31c1a2 100644 --- a/README.packager.md +++ b/README.packager.md @@ -1,46 +1,47 @@ # Outline This readme file currently covers the following topics (further topics will be included in the future): -* Building -* Licensing +* [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 -Rocs follows the -[KDE Licensing policy](https://community.kde.org/Policies/Licensing_Policy). All + 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+. +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: -- `src/LoadSave/Plugins/dotFileFormat/Tests/TestGraphs/*`: EPL-1.0 - -For further information see -`src/LoadSave/Plugins/dotFileFormat/Tests/TestGraphs/README` +- `libgraphtheory/fileformats/dot/autotests/testfiles/`: EPL-1.0 + For further information see + `libgraphtheory/fileformats/dot/autotests/testfiles/README`.