From 8243a656ea9603b88f984b3e5355105d687ae367 Mon Sep 17 00:00:00 2001 From: Eli Holmes Date: Tue, 20 Aug 2024 10:13:11 -0700 Subject: [PATCH] add better instructions regarding the github action --- book/README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/book/README.md b/book/README.md index cba6c25..cbb41b5 100644 --- a/book/README.md +++ b/book/README.md @@ -6,11 +6,13 @@ Everything is here. ### GitHub Action -There is a GitHub Action that should build the book whenever there is a push to the `book` directory. If the Action does not run, then you will need to debug. Click on the Action that did not build and click on the part that had a problem. +There is a GitHub Action that should build the book whenever there is a push to the `book` directory. + +Set Pages to use a GitHub Action. If the Action does not run, then you will need to debug. Click on the Action that did not build and click on the part that had a problem. ### Build locally and push to GitHub -Do `pip install ghp-import` if needed. Then build book and push to GitHub. Set Pages to use `gh-pages` branch. These commands are run within the `book` directory. +Do `pip install ghp-import` if needed. Then build book and push to GitHub. Set Pages to use `gh-pages` branch (which is going to disable deploying from the GitHub Action). These commands are run within the `book` directory. ``` cd /book