Skip to content

Add some documentation in the readme regarding current state of format versions #316

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pehrsoderman merged 1 commit into from
May 16, 2025
Merged

Add some documentation in the readme regarding current state of format versions #316

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,22 @@ Running any of them with the command-line option `-h` gives
documentation on what arguments they accept.


## Format versions

There are currently two versions of the problem package format,
[legacy](https://www.kattis.com/problem-package-format/spec/legacy.html) and
[2023-07-draft](https://www.kattis.com/problem-package-format/spec/2023-07-draft.html).
We have begun work on supporting 2023-07-draft, but there are *many* changes
between legacy and 2023-07-draft which are not yet implemented. Verifyproblem
will do its best to parse and verify problems in 2023-07-draft, but key things
like scoring still behave like legacy. Also, note that 2023-07 is still a draft
standard.

We advice against packaging production problems in 2023-07-draft. Especially so
if you plan to have problems installed on [Kattis](https://open.kattis.com), where
we currently *only* support installing legacy problems.


## Example Problems

A few examples of problem packages can be found in [examples](examples).
Expand Down