Skip to content

Commit b799084

Browse files
updated build instructions
1 parent 573fc87 commit b799084

File tree

1 file changed

+21
-2
lines changed

1 file changed

+21
-2
lines changed

README.md

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,17 +9,36 @@ This textbook is offered under
99
the [Attribution-NonCommercial-ShareAlike 4.0 International (CC BY-NC-SA 4.0) License](https://creativecommons.org/licenses/by-nc-sa/4.0/).
1010
See [the license file](LICENSE.md) for more information.
1111

12-
## Setup and Build
12+
## Development
13+
14+
### Setup
1315

1416
In order to build the book, you need to first install Docker
1517
(instructions here: [https://docs.docker.com/get-docker/](https://docs.docker.com/get-docker/)).
1618

17-
You can then build the book by running
19+
### Contributing
20+
Primary development in this repository happens on the `dev` branch. If you want to contribute to the book,
21+
please branch off of `dev` and make a pull request into `dev`.
22+
23+
The `main` branch contains the source material for the live, publicly viewable HTML book.
24+
25+
### Build locally
26+
27+
You can build the book on your own machine by running
1828
```
1929
./build_html.sh
2030
```
2131
in the root directory of this repository. The book can be viewed in your browser by opening the `source/_build/html/index.html` file.
2232

33+
### Update build environment
34+
35+
You can update the build environment for the book by making changes to `Dockerfile` in the root of the repository in the `main` branch.
36+
If you push any changes to the `Dockerfile` on the `main` branch, GitHub will trigger a rebuild of the docker image,
37+
push it to DockerHub, and update the `build_html.sh` script and book deploy GitHub action with the new image digest.
38+
39+
### Update public html
2340

41+
You can update the live, publicly viewable HTML book by making changes to the `source/` folder in the `main` branch.
42+
If you push any changes to the `source/` folder on the `main` branch, GitHub will trigger a rebuild of the public HTML site.
2443

2544

0 commit comments

Comments
 (0)