Skip to content

Commit

Permalink
Update README.md and project urls
Browse files Browse the repository at this point in the history
  • Loading branch information
FinnLidbetter committed Jun 12, 2024
1 parent 283c9d5 commit b0d1fb8
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 2 deletions.
11 changes: 9 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
3 changes: 3 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -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"]

Expand Down

0 comments on commit b0d1fb8

Please sign in to comment.