Skip to content

Commit f3cbdab

Browse files
committed
Improve README based on feedback in #374
1 parent 83246a7 commit f3cbdab

File tree

1 file changed

+12
-9
lines changed

1 file changed

+12
-9
lines changed

README.md

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -126,20 +126,23 @@ kept up to date).
126126
### Method 3: Run directly from the repository
127127
128128
If you intend to help develop problemtools, or if you just want a bare-bones
129-
way of running them, this is your option.
129+
way of running them, this is your option. Note that python 3.11+ is required to
130+
run problemtools (mentioned here, as this method of running problemtools will
131+
not check python version for you).
130132
131133
For this method, you need to clone the repository (just downloading a
132134
zip archive of it does not work because the project has submodules
133135
that are not included in that zip archive).
134136
135-
Start by setting up your venv, e.g.,
137+
Set up your venv, install the requirements, and compile the various support
138+
programs:
136139
137-
python3 -m venv venv
138-
venv/bin/pip install -r requirements.txt
139-
140-
In order for the tools to work, you first have to compile the various
141-
support programs, which can be done by running `make` in the root
142-
directory of problemtools.
140+
```sh
141+
cd ~/problemtools # Assuming you checkout out problemtools in your home directory
142+
python3 -m venv venv
143+
venv/bin/pip install -r requirements.txt
144+
make
145+
```
143146

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

226229
## Requirements and compatibility
227230

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

0 commit comments

Comments
 (0)