Skip to content

Commit d2e18ff

Browse files
committed
incremental progress on #19
1 parent 6f0a893 commit d2e18ff

File tree

1 file changed

+17
-3
lines changed

1 file changed

+17
-3
lines changed

README.md

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,18 +8,32 @@ The portal site is built with [sphinx](https://www.sphinx-doc.org/).
88
To build the site locally (e.g. for testing new content),
99
use [conda](https://docs.conda.io/) to set up a build environment with all dependencies.
1010

11-
First, make a local clone of this source repository on your machine.
12-
Then, from the `content` directory of the source repository, do this:
11+
First, make a local clone of this source repository on your machine. For example:
12+
13+
```
14+
git clone https://github.com/ProjectPythia/projectpythia.github.io.git
15+
```
16+
17+
Then, change working directories to the local repository's `content` directory:
18+
19+
```
20+
cd projectpythia.github.io/content
21+
```
22+
23+
Set up your a conda environment:
24+
1325
```
1426
conda env create -f ../ci/environment.yml
1527
conda activate pythia
1628
```
1729

1830
You can then build the site:
31+
1932
```
2033
make html
2134
```
22-
and view the built site in your web browser with
35+
and view the built site in your web browser with:
36+
2337
```
2438
open _build/html/index.html
2539
```

0 commit comments

Comments
 (0)