From 944ec813fa016a826d0ebf01aaf1a5a1143bcc3b Mon Sep 17 00:00:00 2001 From: Tom van Woudenberg Date: Mon, 12 Jan 2026 11:14:59 +0100 Subject: [PATCH] Fix TeachBooks link and improve website recreation instructions Updated the link to the TeachBooks package and clarified instructions for recreating the website. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index d033612..377e9dd 100644 --- a/README.md +++ b/README.md @@ -68,6 +68,6 @@ This tool's repository is stored on [GitHub](https://github.com/TeachBooks/templ ## Reuse content Feel free to reuse this content or contribute to it. Please give appropriate credit, provide a link to the license, and indicate if changes were made ([CC BY 4.0 License](https://creativecommons.org/licenses/by/4.0/)) -The website (``) is created using the [TeachBooks Python package](https://github.com/TeachBooks/TeachBooks). To recreate it you have two options (more information in the [TeachBooks manual](https://teachbooks.io/manual/): +The website (``) is created using the [TeachBooks](https://teachbooks.io/). To recreate it you have two options (more information in the [TeachBooks manual](https://teachbooks.io/manual/): - In the GitHub interface: fork this repository, enable Github Pages from the source GitHub actions (Settings - Code and automation - Pages - Build and deployment - Source - GitHub Actions), enable workflows (Actions - I understand my workflows, go ahead and enable them) and run the call-deploy-book workflow (Actions - call-deploy-book - Run workflow - Run workflow). The website is released on the URL as shown on the workflow summary when the workflow has finished (Actions - call-deploy-book - call-deploy-book - Summary). - On your own computer: clone this repository, install the required packages (`pip install -r requirements.txt`) and build the book (`teachbooks build book`). The website is stored locally in `book/_build/index.html`.