diff options
author | Nicolas Williams <nico@cryptonector.com> | 2023-07-10 14:35:11 -0500 |
---|---|---|
committer | Nicolas Williams <nico@cryptonector.com> | 2023-07-10 14:35:11 -0500 |
commit | 295ff72dd0d915405cd5326211c9e01cd8c57975 (patch) | |
tree | 0b95eaa6565fe1414250f608e8c32c39b024cf91 /docs | |
parent | 1ec8be142283f32bc5c0fcda5b8a24eeaa7c37af (diff) |
Update docs/README.md
Diffstat (limited to 'docs')
-rw-r--r-- | docs/README.md | 8 |
1 files changed, 7 insertions, 1 deletions
diff --git a/docs/README.md b/docs/README.md index de6bf5a1..54139053 100644 --- a/docs/README.md +++ b/docs/README.md @@ -13,8 +13,14 @@ Though, you may need to say pip3 instead, depending on your system. Once you have pipenv installed, you can install the dependencies by running `pipenv install` from the `docs` directory. +Also, you may need to run `virtualenv -p /usr/bin/python3 venv/` and +then `source venv/bin/activate`, and only then `pipenv install`. + Once this is done, rerun `./configure` in the jq root directory and then -the Makefile will be able to generate the jq manpage. +the Makefile will be able to generate the jq manpage. You can also just +run `pipenv run build_manpage.py` in the `docs` directory to build the +`jq.1` page manually, and `pipenv run build_mantests.py` to build the +contents of `tests/man.test`. To build the website, run `pipenv run ./build_website.py` from inside the `docs` directory. |