Welcome to the repository that hosts the sources of the official EasyBuild tutorial, see https://easybuilders.github.io/easybuild-tutorial.

Basic info

• tutorial contents are located in docs/ subdirectory

• Markdown is used as syntax

Getting started

This tutorial is rendered via MkDocs, which makes it very easy to preview the result of the changes you make locally.

• First, install mkdocs, including the material theme and additional plugins:

  pip install mkdocs mkdocs-material mkdocs-git-revision-date-localized-plugin
  

• Start the MkDocs built-in dev-server to preview the tutorial as you work on it:

  make preview
  

  or

  mkdocs serve
  

  Visit http://127.0.0.1:8000 to see the local live preview of the changes you make.

• If you prefer building a static preview you can use make or mkdocs build, which should result in a site/ subdirectory that contains the rendered documentation.

Automatic updates

The rendered version of this tutorial at https://easybuilders.github.io/easybuild-tutorial is automatically updated on every push to the main branch, thanks to the GitHub Actions workflow defined in .github/workflows/deploy.yml.

The gh-pages branch in this repository contains the rendered version.

https://easybuilders.github.io/easybuild-tutorial will only be updated if the tests pass, see GitHub Actions workflow defined in .github.workflows/test.yml.

Note: do not change the files in the gh-pages branch directly!

All your changes will be lost the next time the main branch is updated...