Skip to content
Snippets Groups Projects
Commit 4929cbe9 authored by Tomáš Pecka's avatar Tomáš Pecka
Browse files

update README

parent 00c3393d
No related branches found
No related tags found
No related merge requests found
Pipeline #23916 canceled
...@@ -17,45 +17,57 @@ line, and partially using a GUI interface. ...@@ -17,45 +17,57 @@ line, and partially using a GUI interface.
   
The Latest Version The Latest Version
------------------ ------------------
Details of the latest version can be found visitng our [gitlab project page][1]. Details of the latest version can be found visiting our [gitlab project page][1].
You can also take look at our [prebuilt Docker images][5].
   
   
Requirements Requirements
------------ ------------
Project is pure C++ builded by cmake. Some tests are handled by Project is pure C++ builded by `cmake`. Some tests are handled by
shell scripts. shell scripts.
   
Cli: Build tools:
* `cmake >= 3.9` * `cmake >= 3.7`
* `make >= 3.9` * `make >= 3.9`
* `g++ >= 7.3` or `clang++ >= 5.0` * `g++ >= 6.3` or `clang++ >= 5.0` (compilation in C++17)
* `libcppunit-dev`
* `libtclap-dev` Libraries:
* `libxml2-dev` * `cppunit`
* `readline-dev` * `tclap`
* `doxygen` (optional for documentation generation) * `libxml2`
* `graphviz` (optional for documentation generation and automata * `readline`
visualizations)
For GUI, you will need also the following libraries:
Gui:
* `Qt5-qtbase >= 5.7` * `Qt5-qtbase >= 5.7`
* `libjsoncpp-dev` * `jsoncpp`
* `graphviz-dev` * `graphviz`
Optional dependencies:
* `doxygen` (for documentation generation)
* `graphviz` (for documentation generation and automata visualizations)
   
   
Installation Installation
------------ ------------
1. Clone the repo: `git clone` or download sources of [stable release][3] 1. Clone the repo: `git clone` or download sources of [stable release][3]
and extract it. and extract it.
2. Change directory and compile: `cd automata-library` and `make`. 2. Change directory and create a build folder: `cd algorithms-library && mkdir build`.
3. Run :) 3. Generate `CMakeLists`:
- `../CMake/generate.py -wm` if you want to build whole project
- or `../CMake/generate.py -wm -g cli` if you want to build cli only
4. Run `cmake` and build: `cmake .. && make`
5. Install: `make install` or `make DESTDIR=./install install` for local install.
6. Run :)
   
* *Optional step:* Generate documentation by executing `make doc`. * *Optional step:* Generate documentation by executing `make doc`.
* *Optional step:* Run tests with `make test`
   
   
Documentation Documentation
------------- -------------
Developer documentation is available for generation using makefile (requires Developer documentation can be generated using `make doc` command (requires
`doxygen`) and will be attached in release packages. `doxygen`) and will be attached in release packages.
   
   
...@@ -104,8 +116,9 @@ Authors ...@@ -104,8 +116,9 @@ Authors
* et. al. * et. al.
   
   
[1]: https://gitlab.fit.cvut.cz/travnja3/automata-library [1]: https://gitlab.fit.cvut.cz/algorithms-library-toolkit/automata-library
[2]: http://www.vim.org/scripts/script.php?script_id=441 [2]: http://www.vim.org/scripts/script.php?script_id=441
[3]: https://gitlab.fit.cvut.cz/travnja3/automata-library/tags [3]: https://gitlab.fit.cvut.cz/algorithms-library-toolkit/automata-library/tags
[4]: https://gitlab.fit.cvut.cz/travnja3/automata-library/forks/new [4]: https://gitlab.fit.cvut.cz/algorithms-library-toolkit/automata-library/forks/new
[5]: https://gitlab.fit.cvut.cz/algorithms-library-toolkit/automata-library/container_registry
[logo]: docs/logo.png [logo]: docs/logo.png
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment