Skip to content

Commit

Permalink
Add link to example's yaml file
Browse files Browse the repository at this point in the history
  • Loading branch information
kna27 authored Aug 17, 2023
1 parent 1590ff6 commit addb7a6
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion CHALL_YAML_GUIDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`
Expand Down

0 comments on commit addb7a6

Please sign in to comment.