Skip to content

Commit 49ca037

Browse files
committed
More feedback.
1 parent 95d372d commit 49ca037

File tree

2 files changed

+7
-10
lines changed

2 files changed

+7
-10
lines changed

Makefile

+1-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ json-schema.tar.gz: $(OUT)
2828
$(VENV): requirements.txt
2929
python -m venv $@
3030
$@/bin/python -m pip install --upgrade pip
31-
$@/bin/python -m pip install -r requirements.txt
31+
$@/bin/python -m pip install -r $<
3232

3333
spec-clean:
3434
rm -f $(OUT) json-schema.tar.gz

README.md

+6-9
Original file line numberDiff line numberDiff line change
@@ -35,19 +35,16 @@ Labels are assigned based on [Sensible Github Labels](https://github.com/Releque
3535
* links.json - JSON Hyper-Schema's Link Description Object meta-schema
3636
* hyper-schema-output.json - The recommended output format for JSON Hyper-Schema links
3737

38-
The Makefile can create the necessary Python virtual environment for you:
38+
The Makefile will create the necessary Python venv for you as part of the regular make target.
3939

40-
```sh
41-
make venv
42-
source .venv/bin/activate
43-
make
44-
```
40+
`make clean` will remove all output including the venv. To clean just the spec output and
41+
keep the venv, use `make spec-clean`.
4542

46-
Or you can manually install "xml2rfc" using "pip" (https://pypi.org/project/xml2rfc/) and type "make" at a shell to build the .txt and .html spec files:
43+
If you want to run `xml2rfc` manually after running make for the first time, you will
44+
need to activate the virtual environment:
4745

4846
```sh
49-
pip install --requirement requirements.txt
50-
make
47+
source .venv/bin/activate
5148
```
5249

5350
The version of "xml2rfc" that this project uses is updated by modifying `requirements.in` and running `pip-compile requirements.in`.

0 commit comments

Comments
 (0)