diff --git a/README.md b/README.md index 99dbd62..ff190b7 100644 --- a/README.md +++ b/README.md @@ -6,9 +6,14 @@ This is the template book. You can fork this to create a book in as easy-as-poss 1. Click `Fork`, and set a name for your new book. 2. To enable deploying via GitHub Actions, go to `⚙ Settings`, then to `Pages`, and under `Build and Deployment` set `Source` to `GitHub Actions`. -3. To trigger a deployment for the first time, you can go to `Actions` (top panel), then click `deploy-book` on the left, then `Run workflow` on the right. The book is also automatically deployed whenever commits are pushed onto the `main` branch of the repository (in absence of errors). +3. To trigger a deployment for the first time, you can go to `Actions` (top panel), then click `deploy-book` on the left, then `Run workflow` on the right. The book is also automatically deployed whenever commits are pushed (in absence of errors). Voila! You can now access the copy of the template at -`https://.github.io/` (e.g. https://teachbooks.github.io/template). +`https://.github.io//` (e.g. https://teachbooks.github.io/template). + +It is possible to have multiple versions of a book published at once, by creating another Git branch (e.g. `draft` or `dev`). +For each branch, the respective book is published at `https://.github.io//`. +Technical note: for convenience, just `https://.github.io//` redirects to `https://.github.io//book/`, which is itself an alias (a symlink) to +`https://.github.io//main/`. To learn more about how we do this, please see the [GitHub Actions documentation](https://docs.github.com/en/actions) and our deployment pipeline configuration file `.github/workflows/deploy-book-ghpages.yml`.