Commit 56bd3a68 authored by Grant Likely's avatar Grant Likely
Browse files

Add a quickstart guide.



Adds some simple instructions to the top of the README file so that
a users doesn't need to go searching for the instructions.
Signed-off-by: Grant Likely's avatarGrant Likely <grant.likely@arm.com>
parent 06eb8813
# SCT_Parser
# EDK2 SCT Results Parser
This is an external parser script for [UEFI SCT]. (WIP)
......@@ -9,6 +9,19 @@ It will proceed to generate a Markdown file listing number of failures, passes,
[UEFI SCT]: https://uefi.org/testtools
## Quick Start
If you're using this tool to analyze EBBR test results, use the following
command. The parsed report can be found in `result.md`.
``` {.sh}
$ ./parser.py --config EBBR.yaml \
</path/to/sct_results/Overall/Summary.ekl> \
<path/to/sct_results/Sequence/EBBR.seq>
INFO apply_rules: Updated 200 test(s) out of 12206 after applying 124 rule(s)
INFO main: 0 dropped(s), 1 failure(s), 93 ignored(s), 106 known u-boot limitation(s), 12006 pass(s), 0 warning(s)
```
## 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`.
......
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