Skip to content

Commit

Permalink
markdown formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
dimbleby committed Jul 5, 2023
1 parent 4a446c9 commit f84f5c4
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 10 deletions.
12 changes: 7 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,11 @@

# Running the CI lints locally

See [linting.yml](.github/workflows/linting.yml) for the list of linting commands run by the CI on Github,
such as:
See [linting.yml](.github/workflows/linting.yml) for the list of linting
commands run by the CI on Github, such as:

`poetry run ruff .`
`poetry run black --check .`
`poetry run mypy .`
```shell
$ poetry run ruff .
$ poetry run black --check .
$ poetry run mypy .
```
13 changes: 8 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,14 +105,17 @@ and N+1.
You can use the files in `dummy_files.zip`, updating `blurb.txt` at level 0 with
text for the start of the hunt.

It is recommended that, prior to attempting upload, that [level_validation.py](admin_scripts/level_validation.py)
be run over the levels. This will catch numerous formatting problems with the levels before wasting your
time/bandwidth on server upload, and will also catch several conditions that are not technically errors
but are undesirable, such as empty README.md files and too-tight tolerances.
It is recommended, prior to attempting upload, that
[level_validation.py](admin_scripts/level_validation.py) be run over the levels.
This will catch numerous formatting problems with the levels before wasting your
time/bandwidth on server upload, and will also catch several conditions that are
not technically errors but are undesirable, such as empty `README.md` files and
too-tight tolerances.

### Level upload through the API

[upload.py](admin_scripts/upload.py) contains utilities for uploading levels and hints.
[upload.py](admin_scripts/upload.py) contains utilities for uploading levels and
hints.

You'll need to update the `SERVER` and credentials at the top of the file, and
then re-arrange `main()` as appropriate to upload your levels.
Expand Down

0 comments on commit f84f5c4

Please sign in to comment.