about summary refs log tree commit diff
diff options
context:
space:
mode:
authorEmile <HanEmile@users.noreply.github.com>2020-07-02 23:24:10 +0200
committerGitHub <noreply@github.com>2020-07-02 23:24:10 +0200
commit96c464a1fc331ea36bc2bb3433b72127fc66483e (patch)
tree7b1eb9c6560e72c8ab50c1dafff13e6c47145cbd
parent4e90c58c3bbb6f516e410520d47da333b1cf4c6a (diff)
Update README.md
-rw-r--r--README.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/README.md b/README.md
index 7c5c4ce..878b195 100644
--- a/README.md
+++ b/README.md
@@ -48,6 +48,25 @@ Downloading the files included in the challenges
 
 - Dump all files from all challenges
 - A simple directory structure get's created sorting the challenges into the corresponding categories (`<ctfname>/<category>/<challengename>/<challengefiles>`)
+- README.md generation containing the challenge description and some other info:
+
+Example `README.md`, `generated in <ctfname>/<category>/<challengename>/README.md`
+```md
+# Leet
+
+Category: misc
+
+Files:
+- Challenge.awesome1337
+
+## Description
+
+Do you think you're l33t enough?
+
+## Writeup
+```
+
+(Writeup section included to encourage you to publish writeups :D)
 
 ## Contribution