Skip to content

Mention the bootstrap.sh also in README #75

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

Open
frlan wants to merge 1 commit into
base: master
Choose a base branch
from
+4 −1
Open

Mention the bootstrap.sh also in README #75

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
5 changes: 4 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,9 @@ built from the default branch of this repo.

## Development

- On non-Nix machines executing `bootstrap.sh` will create the needed
virtualenv and install all dependencies from `requirements.txt` into it.
Later e.g. `make html` is working without activating the freshly created virtualenv.
- Build full documentation locally with pinned nixpkgs: `nix-build`
- Building with pinned nixpkgs may take some time and download a lot of
stuff if you don't already have the needed packages installed and your
Expand All @@ -32,7 +35,7 @@ built from the default branch of this repo.
- Build english (source language) documentation: `make html`
- Build translated documentation in German: `make html-de`
- Check all links (slow!): `sphinx-build src _build -b linkcheck`
- Show contents of the objects inventory:
- Show contents of the objects inventory:
`python -m sphinx.ext.intersphinx https://doc.flyingcircus.io/platform/objects.inv`

- Update nixpkgs version: change URL in `default.nix` for the `pkgs` argument, right at the top.
Expand Down