From addb7a6e7488990cd145660eeff5bde6ef2fc254 Mon Sep 17 00:00:00 2001 From: krisharora <43799189+kna27@users.noreply.github.com> Date: Wed, 16 Aug 2023 20:26:52 -0400 Subject: [PATCH] Add link to example's yaml file --- CHALL_YAML_GUIDE.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/CHALL_YAML_GUIDE.md b/CHALL_YAML_GUIDE.md index 7fbe5ff..30c544d 100644 --- a/CHALL_YAML_GUIDE.md +++ b/CHALL_YAML_GUIDE.md @@ -6,10 +6,12 @@ This is a guide on what the `chall.yaml` file is, how to create one, and how the ### What is a chall.yaml file? -A `chall.yaml` file contains information about a specific challenge. Each challenge is **required** to have a chall.yaml file in the root of the challenge directory. +A `chall.yaml` file contains information about a specific challenge. Each challenge is **required** to have a `chall.yaml` file in the root of the challenge directory. ARCS uses the information in the `chall.yaml` file to display the challenge's description, points, author, showing file attachments, etc. on the CTF website. It will also host service challenges (if specified) and will automatically add a link to the challenge's service on the CTF website. +See [the example challenge's chall.yaml file](/example/chall.yaml) for an example of a complete and basic `chall.yaml` file. + ## Fields ### `name`