Skip to content

Update README with local running instructions #183

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
SuperCowProducts wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update README with local running instructions #183

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
2 changes: 2 additions & 0 deletions readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,8 @@ Make sure that olean files are generated for mathlib in `_target`, otherwise thi
If you don't have enough RAM to run `./gen_docs`, consider downloading the documentation
from [here](https://github.com/leanprover-community/mathlib_docs) and renaming `docs` to `html`.

If running locally, perform `find -path ./find -prune -o -print -exec sed -i -E 's/https:\/\/leanprover-community.github.io\/mathlib_docs//g' "{}" \;` to fix links before `cd html && python -m http.server`.

The links will point to `/` as the root of the site.
I typically host a server from the `html` directory with `python3 -m http.server`.
If you intend to host the site somewhere else than the root,
Expand Down