Skip to content

Commit 1955f96

Browse files
committed
Touch up doc and test helpers
* Fix some README.md typos * Update DOCKER.md with Python version info * Fix script comments
1 parent 334f932 commit 1955f96

File tree

3 files changed

+11
-12
lines changed

3 files changed

+11
-12
lines changed

DOCKER.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,11 @@
1-
# Docker for a Python 3.8 Test Shim
1+
# I Want To Test on Python $VERSION!
22

3-
**TL;DR:** Run `./test_in_docker.sh 3.8` and look for red
3+
**TL;DR:** Run `./test_in_docker.sh 3.9` and look for red
44

5-
If you already know Docker well, pass a `PYTHON_VERSION` via Docker's
6-
`--build-arg` option like so:
5+
To specify a version, you can manually configure it via Docker's `--build-arg` option like so:
76

87
```console
9-
$ docker build -f tests.Dockerfile --build-arg="PY_VERSION=3.8" -t fontknife:3.8 .
8+
$ docker build -f tests.Dockerfile --build-arg="PY_VERSION=3.9" -t fontknife:3.9 .
109
```
1110

1211
However, the helper script is shorter.
@@ -27,8 +26,8 @@ First, makes you're capable of running Docker containers. For a *NIX system (mac
2726
the steps will be roughly as follows:
2827

2928
1. `cd` into the project root directory
30-
2. Read `run_tests_in_docker.sh` to make sure you understand it
31-
3. Run `sudo ./test_python38.sh` and watch the output
29+
2. Read `test_in_docker.sh` to make sure you understand it
30+
3. Run `sudo ./test_in_docker.sh` and watch the output
3231

3332
## I don't like Docker!
3433

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,11 +25,11 @@ If you only want to convert fonts, follow these steps:
2525
1. Have [Python](https://python.org) 3.9+ installed
2626
2. Make sure you've [created](https://docs.python.org/3/library/venv.html#creating-virtual-enviroments)
2727
and [activated](https://docs.python.org/3/library/venv.html#how-venvs-work)
28-
a virtual environemnt (or use [pipx](https://pypa.github.io/pipx/))
29-
3. `pip install
28+
a virtual environment (or use [pipx](https://pypa.github.io/pipx/))
29+
3. `pip install`
3030
4. Run `fontknife convert --help`
3131

32-
If the last command print help text, you're ready to go! Read it for a descirption of supported arguments.
32+
If the last command prints help text, you're ready to go! Read it for more information about supported features.
3333

3434
### Developers / Contributors
3535

tests.Dockerfile

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Helper for running arbitary Python versions
22
#
3-
# It's easiest to run this with the included script (test_python38.sh)
3+
# It's easiest to run this with the included script (test_in_docker.sh)
44
# See doc/DOCKER.md for more info.
55
ARG PYTHON_VERSION
66
FROM python:${PYTHON_VERSION} AS base
@@ -23,4 +23,4 @@ RUN python -m pip install -e .[dev]
2323

2424
# Set the container to run the helper script unless
2525
# otherwise specified by docker run -i -t $YOUR_COMMAND_HERE
26-
CMD [ 'bash', 'container.sh' ]
26+
CMD [ "bash", "container.sh" ]

0 commit comments

Comments
 (0)