Skip to content

Improve README based on feedback in #374 #375

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
Dec 4, 2025
Merged

Improve README based on feedback in #374 #375

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
21 changes: 12 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,20 +126,23 @@ kept up to date).
### Method 3: Run directly from the repository

If you intend to help develop problemtools, or if you just want a bare-bones
way of running them, this is your option.
way of running them, this is your option. Note that python 3.11+ is required to
run problemtools (mentioned here, as this method of running problemtools will
not check python version for you).

For this method, you need to clone the repository (just downloading a
zip archive of it does not work because the project has submodules
that are not included in that zip archive).

Start by setting up your venv, e.g.,
Set up your venv, install the requirements, and compile the various support
programs:

python3 -m venv venv
venv/bin/pip install -r requirements.txt

In order for the tools to work, you first have to compile the various
support programs, which can be done by running `make` in the root
directory of problemtools.
```sh
cd ~/problemtools # Assuming you checked out problemtools in your home directory
python3 -m venv venv
venv/bin/pip install -r requirements.txt
make
```

When this is done, you can run the three programs
`bin/verifyproblem.sh`, `bin/problem2pdf.sh`, and
Expand Down Expand Up @@ -225,7 +228,7 @@ problemtools' configuration:

## Requirements and compatibility

To build and run the tools, you need Python 3 with the YAML and PlasTeX libraries,
To build and run the tools, you need Python 3.11+ with the YAML and PlasTeX libraries,
and a LaTeX installation. You must also install language tools (e.g., compilers)
for any languages used in problem packages.

Expand Down