From 3ccc127cda94e3b7d95d83ea3ff44d216351739a Mon Sep 17 00:00:00 2001 From: Jaime Arias <arias@lipn.univ-paris13.fr> Date: Mon, 16 Jan 2023 09:25:43 +0100 Subject: [PATCH] update README --- README.md | 41 +++++++++++++++++++++-------------------- 1 file changed, 21 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index d736565..a6a0923 100644 --- a/README.md +++ b/README.md @@ -1,34 +1,35 @@ # Symbolic Observation Graph-Based Generation of Test Paths -`sog-test-paths` generates the observable paths from a Petri net model. It also +`sogMBT` generates the observable paths from a Petri net model. It also generates the abstract paths. ## Requirements -- A C++ compiler (`gcc >= 9.3.0`). +- `gcc >= 9.3.0`. +- `cmake` -## Compilation +## Build -The tool can be compiled as follow: +The tool can be compiled as follows: -- First, run the `make` command inside the directory `buddy22` in order to build - the library used to manipulate Binary Decision Diagrams (BDD). - -- Second, run `make` in the `parser` directory in order to build the library - used to parse Petri net models from `net` files. - -- Third, run the `make` command in the root directory to generate the executable - file `sog-test-paths`. +```bash +mkdir build && cd build +cmake .. +make +``` ## Use ``` -./sog-test-paths <command> +λ> ./sogMBT --help +sogMBT: Symbolic Observation Graph-Based Generation of Test Paths +Usage: ./sogMBT [OPTIONS] + +Options: + -h,--help Print this help message and exit + --input-net Path:FILE REQUIRED + Petri net file + --output-folder Path:DIR REQUIRED + output folder + --obs-file Path:FILE Cover observable transitions from file [default: all transitions] ``` - -The following commands are available: - -- To generate the reachability graph: use the option `-r <filename.net>`. -- To generate test paths covering the given observable transitions `t1,t2,...,tn`, use the option `-o <filename.net> <output_file>`. -- To generate test paths using structural analysis, use the option `-a <filename.net>` -- To generate the complete SOG corresponding to observable transitions, use the option `-c <filename.net>` -- GitLab