Skip to content

Commit

Permalink
added instructions to use the codespace
Browse files Browse the repository at this point in the history
  • Loading branch information
turnmanh committed May 28, 2024
1 parent a62547a commit 264436c
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,14 @@ learning stack are however highly recommended.

## Setup

Besides setting up the environment yourself, we provide a devcontainer that can
either be used locally or inside a GitHub Codespace. TO quickly spin up an
instance, holding the training's content and the necessary environment, click
the green button "Code" in the top right corner of the repository and select
"Codespaces" rather than local development.

If you prefer to work locally, you can set up the environment as follows:

We recommend to install rise with conda (installation with pip may cause problems). We also use the
[spellchecker](https://jupyter-contrib-nbextensions.readthedocs.io/en/latest/nbextensions/spellchecker/README.html)
and [equation-numbering](https://jupyter-contrib-nbextensions.readthedocs.io/en/latest/nbextensions/equation-numbering/readme.html)
Expand Down

0 comments on commit 264436c

Please sign in to comment.