diff --git a/.gitignore b/.gitignore index 8d98f9d..afefbce 100644 --- a/.gitignore +++ b/.gitignore @@ -1 +1,2 @@ .* +*.pdf diff --git a/README.md b/README.md new file mode 100644 index 0000000..89ffd2c --- /dev/null +++ b/README.md @@ -0,0 +1,17 @@ +# penretem + +_Sounds like passata 'cause it is as delicious_ + +Penetration Test report template written in [typst](https://typst.app). + +- Provides a *Management Summary*, *Test Scope*, *Findings*, and *Appendix* section +- Easy to use, handles the formatting and typesetting hassle for you - as well as all those text you copy-paste anyway +- Supports [CVSS V3.1](https://www.first.org/cvss/v3-1/) + +## Usage + +Clone this repository and start writing. For a normal, off-the-shelf report, you'll only need to edit the `main.typ` and `findings.typ`. + +After that, run `typst compile main.typ`. + +The template has some placeholders. They are highlighted in red; to make double-sure that all of them are removed before you submit the report, call `#helper.panicOnPlaceholder.update(true)`. The `typst compile` call will then panic at the first placeholder it finds.