Skip to content

Commit

Permalink
incremental progress on #19
Browse files Browse the repository at this point in the history
  • Loading branch information
clyne committed May 12, 2021
1 parent 6f0a893 commit d2e18ff
Showing 1 changed file with 17 additions and 3 deletions.
20 changes: 17 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,18 +8,32 @@ The portal site is built with [sphinx](https://www.sphinx-doc.org/).
To build the site locally (e.g. for testing new content),
use [conda](https://docs.conda.io/) to set up a build environment with all dependencies.

First, make a local clone of this source repository on your machine.
Then, from the `content` directory of the source repository, do this:
First, make a local clone of this source repository on your machine. For example:

```
git clone https://github.com/ProjectPythia/projectpythia.github.io.git
```

Then, change working directories to the local repository's `content` directory:

```
cd projectpythia.github.io/content
```

Set up your a conda environment:

```
conda env create -f ../ci/environment.yml
conda activate pythia
```

You can then build the site:

```
make html
```
and view the built site in your web browser with
and view the built site in your web browser with:

```
open _build/html/index.html
```
Expand Down

0 comments on commit d2e18ff

Please sign in to comment.