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

Add testing instruction to README

This commit is contained in:
Robin Jadoul 2016-05-29 18:39:32 +02:00
parent a24320099c
commit bb855836f6
1 changed files with 23 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
README.md
View File

@ -25,11 +25,11 @@ This project came into existence as an application exercise in a course on regul
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.
Run Run
```sh
sudo apt-get update && sudo apt-get -y install software-properties-common; \ sudo apt-get update && sudo apt-get -y install software-properties-common; \
sudo add-apt-repository -y ppa:george-edison55/cmake-3.x; \ sudo add-apt-repository -y ppa:george-edison55/cmake-3.x; \
sudo apt-get update && sudo apt-get install -y cmake sudo apt-get update && sudo apt-get install -y cmake
```
to get this newer version to get this newer version
## Used dependencies ## Used dependencies
@ -40,18 +40,28 @@ The following dependencies will be automatically downloaded with git while build
## Building ## Building
Get your terminal in the source tree and run the following commands: Get your terminal in the source tree and run the following commands:
```sh
mkdir build mkdir build
cd build cd build
cmake .. cmake ..
make make
make install make install
```
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).
### Running tests ### Running tests
**TODO** First, build Lexesis in debug mode. The only difference with the normal building, is the line where you call cmake. That line should read
cmake .. -DCMAKE_BUILD_TYPE=Debug
instead. Afterwards, build all the examples as well, since they are used to test the functionality of the generated lexers.
If everything is correctly built, the only thing that remains is to call
python3 run_tests.py
in the project root, and watch the results.
## Getting started ## Getting started