Commit 98a90d2c authored by Vincent Stehlé's avatar Vincent Stehlé
Browse files

README.md: document HTML generation



Refine the documentation of the result.md and explain how to generate HTML
with pandoc.
Signed-off-by: Vincent Stehlé's avatarVincent Stehlé <vincent.stehle@arm.com>
parent 1256fcf8
......@@ -23,12 +23,28 @@ INFO main: 0 dropped(s), 1 failure(s), 93 ignored(s), 106 known u-boot limitatio
```
## Usage
Usage to generate a "result md" is such. `python3 parser.py <log_file.ekl> <seq_file.seq>`
If you do no provided any command line arguments it will use `sample.ekl` and `sample.seq`.
The output filename can be specified with `--md <filename>`.
Usage to generate a `result.md` is such:
``` {.sh}
$ python3 parser.py <log_file.ekl> <seq_file.seq>
```
If you do no provided any command line arguments it will use `sample.ekl` and
`sample.seq`. The output filename can be specified with the `--md` option:
``` {.sh}
$ ./parser.py --md out.md ...
```
An online help is available with the `-h` option.
The generated `result md` can be easily converted to HTML using `pandoc` with:
``` {.sh}
$ pandoc -oresult.html result.md
```
### Custom search
For a custom Key:value search, the next two arguments *MUST be included together.* The program will search and display files that met that constraint, without the crosscheck, and display the names, guid, and key:value to the command line. `python3 parser.py <file.ekl> <file.seq> <search key> <search value>`
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment