Merge pull request #39 from nsec/readme

Added README to a newly created track. Modified README file structure.

Author: MOBergeron

README.md

@@ -35,7 +35,13 @@ my-ctf/
 │   │   ├── track.yaml            # Main file that describes the track
 │   │   ├── files/                # Directory that contains all the files available for download in the track
 │   │   │   ├── somefile.zip
+│   │   │   ├── askgod/
+│   │   │   │   ├── gifs/         # GIF directory for askgod fireworks.
+│   │   │   │   │   └── my-gif.gif
+│   │   │   │   ├── sounds/       # Sound directory for askgod fireworks.
+│   │   │   │   │   └── my-sound.mp3
 │   │   ├── ansible/              # Directory containing Ansible playbooks to configure the track
+│   │   │   ├── build.yaml        # Optional: Playbook when a build container is needed
 │   │   │   ├── deploy.yaml       # Main playbook to deploy the track
 │   │   │   └── inventory         # Inventory file for Ansible
 │   │   ├── terraform/            # Directory containing OpenTofu (terraform fork) files to describe the infrastructure

ctf/new.py

@@ -135,6 +135,17 @@ def new(
 
     LOG.debug(msg=f"Wrote {p}.")
 
+    readme_template = env.get_template(name=os.path.join("common", "README.md.j2"))
+    render = readme_template.render(data={"name": name})
+    with open(
+        file=(p := os.path.join(new_challenge_directory, "README.md")),
+        mode="w",
+        encoding="utf-8",
+    ) as f:
+        f.write(render)
+
+    LOG.debug(msg=f"Wrote {p}.")
+
     posts_directory = os.path.join(new_challenge_directory, "posts")
 
     os.mkdir(path=posts_directory)

ctf/templates/new/common/README.md.j2

@@ -0,0 +1,15 @@
+# {{ data.name }}
+
+## Description
+
+TODO CHANGE_ME: This track ....
+
+## Theme
+
+TODO CHANGE_ME: This track incorporates as the control center of a satelite moving around the Earth. It is asked of the participant to take control of it...
+
+## Solutions
+
+### Flag 1
+
+TODO CHANGE_ME: This is a walkthrough of how to get the first flag.