[doc] Add important note to readme that the latest version only supports 2023-07-draft

Author: mpsijm

doc/commands.md

@@ -43,6 +43,7 @@ This lists all subcommands and their most important options.
   - [`bt solve_stats [--contest-id CONTESTID] [--post-freeze]`](#solve_stats)
   - [`bt sort`](#sort)
   - [`bt update_problems_yaml [--colors COLORS] [--sort]`](#update_problems_yaml)
+  - [`bt upgrade`](#upgrade)
   - [`bt tmp [--clean]`](#tmp)
   - `bt create_slack_channels --token xoxb-...`
 
@@ -634,6 +635,11 @@ This file should contain a list of problems, with for every problem the keys `id
   Should be a comma-separated list of colors (hash-sign is optional), e.g.: `--colors ff0000,00ff00,0000ff`.
 - `--sort`: Sort the problems in `problems.yaml` and re-label them starting from `A` (or `X` if `contest.yaml` contains `test_session: True`).
 
+## `upgrade`
+
+`bt upgrade` upgrades a problem from problem format version [`legacy`](https://icpc.io/problem-package-format/spec/legacy.html)
+to [`2023-07-draft`](https://icpc.io/problem-package-format/spec/2023-07-draft.html).
+
 ## `tmp`
 
 `bt tmp` prints the temporary directory that's used for all compilation output, run results, etc for the current problem or contest:

readme.md

@@ -13,10 +13,18 @@ time since I'm not aware of usage outside of BAPC yet.
 
 ## Installation
 
-You can install the [bapctools-git AUR
-package](https://aur.archlinux.org/packages/bapctools-git/), mirrored
-[here](https://github.com/RagnarGrootKoerkamp/bapctools-git), or use the [Docker
-image](#Docker).
+> [!IMPORTANT]
+> The latest version of BAPCtools is only compatible with problem format version
+> [`2023-07-draft`](https://icpc.io/problem-package-format/spec/2023-07-draft.html).
+> The [`bt upgrade` command](https://github.com/RagnarGrootKoerkamp/BAPCtools/blob/HEAD/doc/commands.md#upgrade)
+> is a best-effort automated way to upgrade `legacy` problems to `2023-07-draft`.
+> To use BAPCtools with `legacy` problems,
+> you can use the [`legacy` branch](https://github.com/RagnarGrootKoerkamp/BAPCtools/tree/legacy) of this repository,
+> which is no longer maintained.
+
+You can install the [bapctools-git AUR package](https://aur.archlinux.org/packages/bapctools-git/),
+mirrored [here](https://github.com/RagnarGrootKoerkamp/bapctools-git),
+or use the [Docker image](#Docker).
 
 Otherwise, clone this repository and install the required dependencies manually.
 (If you know how to make a Debian package, feel free to help out.)
@@ -35,7 +43,7 @@ Otherwise, clone this repository and install the required dependencies manually.
 Optional dependencies, required for some subcommands:
 
 - The [ruamel.yaml library](https://pypi.org/project/ruamel.yaml/) via `pip install ruamel.yaml` or the `python-ruamel-yaml` Arch Linux package (`python3-ruamel.yaml` on Debian derivatives).
-  - This is only needed for commands that update `generators.yaml`.
+  - This is only needed for commands that update `generators.yaml` and `bt upgrade`.
 - The `latexmk` and `pdflatex` commands, provided by `texlive-bin` on Arch Linux and
   potentially some specific LaTeX packages (like tikz) provided by
   `texlive-extra`.