Skip to content

Commit 153e455

Browse files
authored
Update README.md
Replace template text by description of the training lesson
1 parent 60f25bf commit 153e455

1 file changed

Lines changed: 5 additions & 40 deletions

File tree

README.md

Lines changed: 5 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -1,48 +1,13 @@
1-
# Elixir Training Lesson template
1+
# Elixir Training Lesson: Literate Programming in R
22

3-
[![DOI](https://zenodo.org/badge/564252010.svg)](https://zenodo.org/badge/latestdoi/564252010)
3+
(placeholder for badge)
44

5+
This repository contains the scripts and source files for the [Elixir Training Lesson: Literate Programming in R](https://elixir-europe-training.github.io/ELIXIR-TrP-LiterateProgrammingR-CodeRep/), using the template from [this repository](https://elixir-europe-training.github.io/ELIXIR-TrP-LessonTemplateInstructions-MkDocs/)
56

6-
For instruction on how to use the template, please follow this documentation:
7-
https://elixir-europe-training.github.io/ELIXIR-TrP-LessonTemplateInstructions-MkDocs/
8-
9-
10-
**Any issues?** Contact Geert van Geest (@GeertvanGeest)
11-
12-
13-
14-
## If working locally
15-
16-
This website is generated with [MkDocs](https://www.mkdocs.org/), with the theme [Material](https://squidfunk.github.io/mkdocs-material/).
17-
18-
To host it locally, install MkDocs:
19-
```bash
20-
pip install mkdocs
21-
```
22-
23-
and Material with some plugins:
24-
```bash
25-
pip install mkdocs-material
26-
pip install mkdocs-video
27-
pip install mkdocs-bibtex
28-
pip install neoteroi-mkdocs
29-
```
30-
31-
Clone this repository to your local computer. Then, make the repository your current directory and type:
32-
33-
```bash
34-
mkdocs serve
35-
```
36-
37-
To host it locally.
38-
39-
Check it out with your browser at [http://localhost:8000/](http://localhost:8000/).
40-
7+
While the training can be completed without referring to this repository at all, comprehension of how the source files lead to the webpages is an indicator of successful completion of the training, as the content i.e. literate programming **is** the way the webpages have been written.
418

429
## Citation
4310

4411
Please cite as
4512

46-
> Geert van Geest, Elin Kronander, Jose Alejandro Romero Herrera, Nadja Žlender, & Alexia Cardona. (2023).
47-
> The ELIXIR Training Lesson Template - Developing Training Together (v1.0.0-alpha). Zenodo.
48-
> https://doi.org/10.5281/zenodo.7913092
13+
(placeholder for citation)

0 commit comments

Comments
 (0)