diff --git a/README.md b/README.md index b354cda..722dd14 100644 --- a/README.md +++ b/README.md @@ -1,31 +1,45 @@ -# Template +# Your first TeachBook using the GitHub template -This is the template book. You can use this book as a template to start your own TeachBook in as easy-as-possible a way. +```{admonition} User types +:class: tip +This page is useful for user type 3, 4 and 5. +``` -# Steps to use this template and publish it online +This page shows you how as an example how to start your own Jupyter Book and hosting that book online. It doesn't elaborate on the collaborative functionalities of Git or how to edit the book. 1. To get started making your Jupyter Book with our functionalities, use the [template book](https://github.com/TeachBooks/template) as template: -![use template](https://teachbooks.tudelft.nl/jupyter-book-manual/_images/use_template.png) +```{figure} figures/use_template.png +:name: use-template +``` 2. Fill in a repository name, this name will be used in the future url of your book: -![create new repository](https://teachbooks.tudelft.nl/jupyter-book-manual/_images/create_new_repository.png) +```{figure} figures/create_new_repository.png +:name: create_new_repository +``` -3. Set source for GitHub pages to GitHub Actions under `Settings` -