Skip to content

Commit

Permalink
Grammar
Browse files Browse the repository at this point in the history
  • Loading branch information
kna27 authored Aug 17, 2023
1 parent 4528810 commit 1590ff6
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions CHALL_YAML_GUIDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ ARCS uses the information in the `chall.yaml` file to display the challenge's de

- **Type:** List of Strings
- **Required:** Yes
- **Description:** The categories that the challenge falls under. Categories MUST be one of the following: `misc`, `binex`, `crypto`, `foren`, `rev`, `webex`.
- **Description:** The categories that the challenge falls under. Categories MUST be `misc`, `binex`, `crypto`, `foren`, `rev`, `webex`.
- **Example:**
```yaml
categories:
Expand Down Expand Up @@ -77,7 +77,7 @@ ARCS uses the information in the `chall.yaml` file to display the challenge's de
- **Example:**
```yaml
description: |
This is a challenge about saying hello to the world. This is **very** important, because I put it in bold.
This is a challenge about saying hello to the world. This is **very** important because I put it in bold.
And this is a new paragraph!
Expand All @@ -104,14 +104,14 @@ ARCS uses the information in the `chall.yaml` file to display the challenge's de
```yaml
deploy:
web: # Name of the container
build: . # Directory relative to the root of the challenge directory that contains the Dockerfile.
build: . # Directory relative to the challenge directory's root containing the Dockerfile.
expose: 1337/tcp # port/<tcp or udp>
```
- netcat Binex Example:
```yaml
deploy:
nc: # Name of the container
build: . # Directory relative to the root of the challenge directory that contains the Dockerfile.
build: . # Directory relative to the challenge directory's root containing the Dockerfile.
expose: 1337/tcp # port/<tcp or udp>
```

Expand All @@ -129,7 +129,7 @@ ARCS uses the information in the `chall.yaml` file to display the challenge's de
### `files`
- **Type:** List of Paths
- **Required:** No
- **Description:** A list of files that will be displayed on the challenge's page to be downloaded. The paths must be relative to the root of the challenge directory. File names can be changed using the `dest` attribute. Note that files from a container can be added here as well, see the example below.
- **Description:** A list of files that will be displayed on the challenge's page to be downloaded. The paths must be relative to the root of the challenge directory. File names can be changed using the `dest` attribute. Note that files from a container can also be added here; see the example below.
- **Example:**
```yaml
files:
Expand Down

0 comments on commit 1590ff6

Please sign in to comment.