Skip to content

Commit

Permalink
Update config and readme
Browse files Browse the repository at this point in the history
  • Loading branch information
katilp authored May 13, 2024
1 parent 087059e commit 3d951ea
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,18 @@

## Building the lesson

This lesson was built from the template lesson [The Carpentries Workbench][workbench] following the [quick-start instructions](https://carpentries.github.io/sandpaper-docs/introduction.html#super-quickstart-copy-a-template-from-github). The repository was created checking the option of including all branches and making it public.
This lesson was built from The Carpentries Workbench template lesson following the [quick-start instructions](https://carpentries.github.io/sandpaper-docs/introduction.html#super-quickstart-copy-a-template-from-github). The repository was created checking the option of including all branches and making it public.

The content can be modified in the `main` branch and the GitHub actions generate and deploy the site to https://cms-opendata-workshop.github.io/workshopqcd-2024-lesson-docker/index.html
The content can be edited in the `main` branch and the GitHub actions generate and deploy the site to https://cms-opendata-workshop.github.io/workshopqcd-2024-lesson-docker/index.html
No attempt for a local build was made, and in principle, there is no need to install R or pandoc. If one wishes to test locally, the instructions are provided in [The Carpentries Workbench][workbench] documentation.

Note that initially, the md source for some content that shows on the generated site (e.g. `setup.md`) resides only in the `outputs-md` branch. It is unclear from the instructions why that happens but to be able to update its contents and show the changes on the site, the `setup.md` file was manually copied to the `main` branch. Updates in the `main` branch are automatically propagated to `outputs-md`.


## Configuring the lesson

Follow the steps below to
complete the initial configuration of a new lesson repository built from this template:
complete the initial configuration of a new lesson repository:

1. **Make sure GitHub Pages is activated:**
navigate to _Settings_,
Expand Down

0 comments on commit 3d951ea

Please sign in to comment.