Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
MasloMaslane committed Aug 6, 2024
1 parent 799dc66 commit 39df74a
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 11 deletions.
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ with features such as:
- [Why?](#why)
- [Installation](#installation)
- [Usage](#usage)
- [Contest types](#contest-types)
- [Reporting bugs and contributing code](#reporting-bugs-and-contributing-code)

### Why?
Expand Down Expand Up @@ -103,6 +104,22 @@ There are also available short aliases for the commands:
- `sinol-make v` for `sinol-make verify`
- `sm` for `sinol-make`

### Contest types

`sinol-make` changes its behavior depending on the contest type specified in `config.yml`. You can specify
the contest type with the `sinol_contest_type` key in config. Here is the table of available contest types and their
features:

| Feature | `default` | `oi` | `oij` | `icpc` |
|-----------------------------------------------------------------------------------------------------|-----------|-------|-------|--------|
| Max score | 100 | 100 | 100 | 1 |
| Default time tool | oiejq | oiejq | oiejq | time |
| Full score if took less than half of the time limit, <br/>otherwise linearly decreasing to 1. || ✔️ |||
| Full score if took less than the time limit | ✔️ || ✔️ | ✔️ |
| Scores must sum up to 100 || ✔️ | ✔️ ||
| Limits can be set for individual tests | ✔️ || ✔️ | ✔️ |
| Verifies if tests are named correctly<br/> (letters within groups increase, group numbers increase) || ✔️ | ✔️ | ✔️ |

### Reporting bugs and contributing code

- Want to report a bug or request a feature? [Open an issue](https://github.com/sio2project/sinol-make/issues).
Expand Down
12 changes: 1 addition & 11 deletions example_package/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -70,17 +70,7 @@ sinol_task_id: abc
# sinol-make can behave differently depending on the value of `sinol_contest_type` key.
# Mainly, it affects how points are calculated.
# If the key is not specified, then `default` is used.
# Possible values are:
# - `default` - Points for a test can only be 100 or 0 (unless checker assigns points).
# Points for a group are calculated based of the lowest number of points for a test in this group.
# If scores are not defined in `scores` key, then all groups have the same number of points,
# summing up to 100.
# - `oi` - Points for a test are unchanged if the execution time is less or equal to the time limit.
# Otherwise, number of points decreases linearly to one depending on the execution time.
# Points for a group are calculated same as in `default` mode.
# - `icpc` - A test passes when the status is OK.
# A group passes when all tests in this group pass.
# A solution passes when all groups pass.
# See README.md for more information.
sinol_contest_type: oi

# You can specify which tests are static (handwritten). This allows sinol-make to differentiate between
Expand Down

0 comments on commit 39df74a

Please sign in to comment.