Skip to content
GitLab
Unverified Commit 33402f0b authored by carlos-tb's avatar carlos-tb Committed by GitHub
Browse files

Update README.md

parent a1169648
Hide whitespace changes
Inline Side-by-side
README.md
View file @ 33402f0b
lesson-example lesson-example
============== ==============
This repository shows how to create a lesson using the This repository shows how to create a lesson using this
[SURF lesson template][styles], SURF lesson template, and is itself an example of the use of the template.
and is itself an example of the use of that template.
Please see <https://sara-nl.github.io/lesson-example/> Please see <https://sara-nl.github.io/lesson-example/>
for a rendered version of this material, for a rendered version of this material,
including detailed instructions on design, setup, and formatting. including detailed instructions on design, setup, and formatting.
...@@ -12,8 +11,7 @@ including detailed instructions on design, setup, and formatting. ...@@ -12,8 +11,7 @@ including detailed instructions on design, setup, and formatting.
1. Do *not* fork this repository directly on GitHub. 1. Do *not* fork this repository directly on GitHub.
Instead, please follow the instructions in [the setup instructions][setup] Instead, please follow the instructions in [the setup instructions][setup]
to create a repository for your lesson by importing material to create a repository for your lesson by importing.
from [the styles repository][styles].
2. Once you have created your repository, 2. Once you have created your repository,
run `bin/lesson_initialize.py` to create standard lesson-specific files. run `bin/lesson_initialize.py` to create standard lesson-specific files.
...@@ -34,10 +32,8 @@ including detailed instructions on design, setup, and formatting. ...@@ -34,10 +32,8 @@ including detailed instructions on design, setup, and formatting.
6. Run `make lesson-check` to check that your files follow our formatting rules. 6. Run `make lesson-check` to check that your files follow our formatting rules.
7. If you find an error or omission in this documentation, 7. If you find an error or omission in this template or in its documentation,
please [file an issue in this repository][example-issues]. please [file an issue in this repository][example-issues].
If you find an error or omission in the lesson template,
please [file an issue in the styles repository][styles-issues] instead.
## Layout ## Layout
...@@ -80,7 +76,7 @@ In brief: ...@@ -80,7 +76,7 @@ In brief:
2. Run `make lesson-check` at any time 2. Run `make lesson-check` at any time
to check that your lesson files follow our formatting rules. to check that your lesson files follow our formatting rules.
If you come across formatting issues that the checker doesn't report, If you come across formatting issues that the checker doesn't report,
please [file an issue in the styles repository][styles-issues]. please [file an issue][issues].
3. For a list of helpful commands run `make` in this directory. 3. For a list of helpful commands run `make` in this directory.
If you are looking for things to work on, If you are looking for things to work on,
...@@ -93,5 +89,3 @@ In brief: ...@@ -93,5 +89,3 @@ In brief:
[issues]: https://github.com/sara-nl/lesson-example/issues [issues]: https://github.com/sara-nl/lesson-example/issues
[rendered]: https://sara-nl.github.io/lesson-example/ [rendered]: https://sara-nl.github.io/lesson-example/
[setup]: https://sara-nl.github.io/lesson-example/setup.html [setup]: https://sara-nl.github.io/lesson-example/setup.html
[styles-issues]: https://github.com/sara-nl/styles/issues/
[styles]: https://github.com/sara-nl/styles/
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment