diff --git a/README.md b/README.md index 3af5054ea2e3b8b20c02dbfdc3ef41518fc3c0d0..ce8115d515f658abdc79f223bb11f4dc739e41af 100644 --- a/README.md +++ b/README.md @@ -17,45 +17,57 @@ line, and partially using a GUI interface. 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 ------------ -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. -Cli: - * `cmake >= 3.9` +Build tools: + * `cmake >= 3.7` * `make >= 3.9` - * `g++ >= 7.3` or `clang++ >= 5.0` - * `libcppunit-dev` - * `libtclap-dev` - * `libxml2-dev` - * `readline-dev` - * `doxygen` (optional for documentation generation) - * `graphviz` (optional for documentation generation and automata -visualizations) - -Gui: + * `g++ >= 6.3` or `clang++ >= 5.0` (compilation in C++17) + +Libraries: + * `cppunit` + * `tclap` + * `libxml2` + * `readline` + +For GUI, you will need also the following libraries: * `Qt5-qtbase >= 5.7` - * `libjsoncpp-dev` - * `graphviz-dev` + * `jsoncpp` + * `graphviz` + +Optional dependencies: + * `doxygen` (for documentation generation) + * `graphviz` (for documentation generation and automata visualizations) + Installation ------------ 1. Clone the repo: `git clone` or download sources of [stable release][3] and extract it. - 2. Change directory and compile: `cd automata-library` and `make`. - 3. Run :) + 2. Change directory and create a build folder: `cd algorithms-library && mkdir build`. + 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:* Run tests with `make test` 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. @@ -104,8 +116,9 @@ Authors * 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 -[3]: https://gitlab.fit.cvut.cz/travnja3/automata-library/tags -[4]: https://gitlab.fit.cvut.cz/travnja3/automata-library/forks/new +[3]: https://gitlab.fit.cvut.cz/algorithms-library-toolkit/automata-library/tags +[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