thomasave
/
Lexesis
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add documentation building and improved example building to README

This commit is contained in:
Robin Jadoul 2016-05-30 19:15:15 +02:00
parent 8c91d4c42a
commit 05e49a9fba
1 changed files with 8 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -21,6 +21,7 @@ This project came into existence as an application exercise in a course on regul
* git * git
* CMake 3.2.2+ * CMake 3.2.2+
* Boost variant header library (needed for mstch) * Boost variant header library (needed for mstch)
* Doxygen (optional, needed for building documentation)
For those still on *Ubuntu Trusty*, the default cmake version is still 2.8.12, so there is a ppa available with a more up-to-date version. For those still on *Ubuntu Trusty*, the default cmake version is still 2.8.12, so there is a ppa available with a more up-to-date version.
@ -50,6 +51,12 @@ Get your terminal in the source tree and run the following commands:
This will place the Lexesis executable in the `build/bin` folder, with some extra needed data for Lexesis in `build/share` This will place the Lexesis executable in the `build/bin` folder, with some extra needed data for Lexesis in `build/share`
You can now simply run `./bin/Lexesis` with the arguments you like (see below and in the man pages for an overview). You can now simply run `./bin/Lexesis` with the arguments you like (see below and in the man pages for an overview).
If you want to build the documentation as well, simply run
make doc
The output should be located in `build/doc`, with the main *html* page in `build/doc/html/index.html`.
### Running tests ### Running tests
First, build Lexesis in debug mode. The first difference with the normal building, is the line where you call cmake. That line should read First, build Lexesis in debug mode. The first difference with the normal building, is the line where you call cmake. That line should read
@ -57,6 +64,7 @@ First, build Lexesis in debug mode. The first difference with the normal buildin
instead. Afterwards, after calling `make install`, build all the examples as well with instead. Afterwards, after calling `make install`, build all the examples as well with
cmake .
make examples make examples
since they are used to test the functionality of the generated lexers. since they are used to test the functionality of the generated lexers.