From 6c62257f8101adcd4fd13631b743e9af127e6f8e Mon Sep 17 00:00:00 2001 From: Tom van Woudenberg Date: Wed, 11 Dec 2024 15:50:37 +0100 Subject: [PATCH] flip content in readme --- README.md | 28 ++++++++++++++-------------- 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index b6e00af..de47695 100644 --- a/README.md +++ b/README.md @@ -4,20 +4,6 @@ The template allows you to start your own TeachBook and hosting that TeachBook online without knowledge on Git, the Jupyter book package, python or anaconda. It doesn't elaborate on the collaborative functionalities of Git or how to edit the book. Please look at our manual (https://teachbooks.io/manual) to find more about that! -## Features -- A github repository structure for making a [Jupyter Book](https://github.com/executablebooks/jupyter-book) (`/book`) -- An empty TeachBook containing an intro page on root, an example markdown page, an example jupyter notebook page, an example references page. and an example credits page. (`/book/_toc.yml`, `/book/_config.yml`, `/book/credits.md`, `/book/intro.md`, `/book/references.md`, `/book/some_content/overview.md`, `/book/some_content/text_and_code.ipynb`) -- A file ready for adding references (`references.bib`, `/book/references.md`) -- An example favicon (web browser icon) (`/book/figures/favicon.ico`, `book/_config.yml`.) -- An example logo (`/book/figures/TUDelft_logo_rgb.png`, `/book/config.yml`) -- The configuration files set ready to make your Jupyter Notebooks pages work with [live code using our sphinx-thebe extension](https://teachbooks.io/manual/features/live_code.html) and our recommended settings (`/book/config.yml`) -- An example of setting up preprocessing your table of contents to hide certain draft chapters for eg. students (`_toc.yml`) -- A file containing all the recommended software packages (`requirements.txt`) -- A file containing the recommended license CC BY 4.0 (`LICENSE.md`) -- Our [GitHub workflow for publishing your TeachBook to GitHub Pages](https://github.com/TeachBooks/deploy-book-workflow) (`.github/workflow/call-deploy-book.yml`) -- A gitignore file containing standard python filetype to ignore (`.gitignore`) -- A readme containing information how to use the template, which can adjusted after using the template (`README.md`) - ## How to get started How to use the template is demonstrated in the figure below, all steps are elaborated on in the following step-by-step tutorial. @@ -53,5 +39,19 @@ Set the repository website as your GitHub Pages website under `Code`- `About` - ![GitHub pages as website](figures/use_github_pages_website.png) +## Features +- A github repository structure for making a [Jupyter Book](https://github.com/executablebooks/jupyter-book) (`/book`) +- An empty TeachBook containing an intro page on root, an example markdown page, an example jupyter notebook page, an example references page. and an example credits page. (`/book/_toc.yml`, `/book/_config.yml`, `/book/credits.md`, `/book/intro.md`, `/book/references.md`, `/book/some_content/overview.md`, `/book/some_content/text_and_code.ipynb`) +- A file ready for adding references (`references.bib`, `/book/references.md`) +- An example favicon (web browser icon) (`/book/figures/favicon.ico`, `book/_config.yml`.) +- An example logo (`/book/figures/TUDelft_logo_rgb.png`, `/book/config.yml`) +- The configuration files set ready to make your Jupyter Notebooks pages work with [live code using our sphinx-thebe extension](https://teachbooks.io/manual/features/live_code.html) and our recommended settings (`/book/config.yml`) +- An example of setting up preprocessing your table of contents to hide certain draft chapters for eg. students (`_toc.yml`) +- A file containing all the recommended software packages (`requirements.txt`) +- A file containing the recommended license CC BY 4.0 (`LICENSE.md`) +- Our [GitHub workflow for publishing your TeachBook to GitHub Pages](https://github.com/TeachBooks/deploy-book-workflow) (`.github/workflow/call-deploy-book.yml`) +- A gitignore file containing standard python filetype to ignore (`.gitignore`) +- A readme containing information how to use the template, which can adjusted after using the template (`README.md`) + ## 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`.