Mercurial > repos > public > sbplib_julia

diff README.md @ 842:ef78f730cbb4 feature/setup_documenter

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
More info in the readme
author Jonatan Werpers <jonatan@werpers.com>
date Fri, 14 Jan 2022 10:06:48 +0100
parents 221ce98d2612
children c9e35f1ca269
line wrap: on
line diff
--- a/README.md	Fri Jan 14 09:59:41 2022 +0100
+++ b/README.md	Fri Jan 14 10:06:48 2022 +0100
@@ -39,6 +39,8 @@
 ```
 The first variant generates files suitable for webserver deployment, i.e setting `prettyurls=true`. The second generates files sutible for local viewing in a web browser, i.e `prettyurls=false`.
 
+To view the documentation locally simply open `docs/build/index.html` in your web browser.
+
 When including the `docs/make.jl` script `prettyurls` is set to `false` by default.
 
 Including `docs/make.jl` from the REPL may be preferable when repeatadely building the documentation since this avoids compilation latency.