diff --git a/README.md b/README.md index 91023df..caef345 100644 --- a/README.md +++ b/README.md @@ -7,11 +7,18 @@ tasks that are completed and tasks that are still outstanding in preparing an icpc-style competitive programming contest. ## Installation -Install crifx with `pip install crifx`. (Does not work yet.) +Install crifx with `pip install crifx`. Building the report will require some +TeX packages. For example, on Ubuntu 22.04 installing the `texlive-latex-extra` +apt package with `apt-get install texlive-latex-extra` should be sufficient. + +If you are using a different operating system, and you are able to run crifx, then +please share your experience by opening an Issue and I would be pleased to update +installation instructions accordingly. ## Using crifx In the root directory for a problemset, run `crifx` from within a problemset nested -directory, or run `crifx /path/to/problemset/root` (not yet implemented). +directory, or run `crifx /path/to/problemset/root` from anywhere to generate a report +for the problemset at the specified path. If there is no `crifx.toml` configuration file in the problemset root directory, then a report will be created using default configuration values. diff --git a/pyproject.toml b/pyproject.toml index 33a8721..593dd03 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -25,6 +25,9 @@ classifiers = [ [project.scripts] crifx = "crifx.cli:main" +[project.urls] +Source = "https://github.com/FinnLidbetter/crifx" + [project.optional-dependencies] dev = ["black", "ruff", "tox", "mypy", "pytest"]