From 8424c5e1fb5631474250859482b92fc1761c502f Mon Sep 17 00:00:00 2001 From: Tom van Woudenberg Date: Thu, 1 May 2025 09:07:07 +0200 Subject: [PATCH] Revert "Update README.md" This reverts commit 533f34828006823a606f18449cc1d9b95e4ad8f7. --- README.md | 17 ----------------- 1 file changed, 17 deletions(-) diff --git a/README.md b/README.md index a1d2881..7fbbb6e 100644 --- a/README.md +++ b/README.md @@ -85,20 +85,3 @@ Set the repository website as your GitHub Pages website under {octicon}`code;1em ## Contribute This tool's repository is stored on [GitHub](https://github.com/TeachBooks/template). The `README.md` of the branch `manual_description` is also part of the [TeachBooks manual](https://teachbooks.io/manual/external/template/README.html) as a submodule. If you'd like to contribute, you can create a fork and open a pull request on the [GitHub repository](https://github.com/TeachBooks/template). To update the `README.md` shown in the TeachBooks manual, create a fork and open a merge request for the [GitHub repository of the manual](https://github.com/TeachBooks/manual). If you intent to clone the manual including its submodules, clone using: `git clone --recurse-submodulesgit@github.com:TeachBooks/manual.git`. - -## Template README -> Remove all of the above after you've taken this template and followed the instructions. The following lines are a template for your own README - -# `` - -`` - -## Contributors -- `` - -## 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 (http://oit.tudelft.nl/Macaulays-method/) 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/): -- 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`.