Skip to content

Commit 351aaa0

Browse files
Simplify README to only relevant info
1 parent a15eda6 commit 351aaa0

File tree

1 file changed

+20
-33
lines changed

1 file changed

+20
-33
lines changed

README.md

Lines changed: 20 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -2,37 +2,24 @@
22

33
This lesson is a template lesson that uses [The Carpentries Workbench][workbench].
44

5-
## Note about lesson life cycle stage
6-
Although the `config.yaml` states the life cycle stage as pre-alpha, **the template is stable and ready to use**. The life cycle stage is preset to `"pre-alpha"` as this setting is appropriate for new lessons initialised using the template.
7-
8-
## Create a new repository from this template
9-
10-
To use this template to start a new lesson repository,
11-
make sure you're logged into Github.
12-
Visit https://github.com/carpentries/workbench-template-md/generate
13-
and follow the instructions.
14-
Checking the 'Include all branches' option will save some time waiting for the first website build
15-
when your new repository is initialised.
16-
17-
If you have any questions, contact [@tobyhodges](https://github.com/tobyhodges)
18-
19-
## Configure a new lesson
20-
21-
Follow the steps below to
22-
complete the initial configuration of a new lesson repository built from this template:
23-
24-
1. **Make sure GitHub Pages is activated:**
25-
navigate to _Settings_,
26-
select _Pages_ from the left sidebar,
27-
and make sure that `gh-pages` is selected as the branch to build from.
28-
If no `gh-pages` branch is available, check _Actions_ to see if the first
29-
website build workflows are still running.
30-
The branch should become available when those have completed.
31-
1. **Update this README with
32-
[relevant information about your lesson](https://carpentries.github.io/lesson-development-training/collaborating-newcomers.html#readme)**
33-
and delete this section.
34-
35-
[cff-home]: https://citation-file-format.github.io/
36-
[cff-sandpaper-docs]: https://carpentries.github.io/sandpaper-docs/editing.html#making-your-lesson-citable
37-
[cffinit]: https://citation-file-format.github.io/cff-initializer-javascript/
5+
## Using the lesson
6+
7+
To step through the lesson, please follow it on its website at https://carpentries-incubator.github.io/reproducible-ml-workflows/
8+
9+
## Developing the lesson
10+
11+
Similar to the lesson itself, development of the lesson uses [Pixi](https://pixi.sh/) to have unified multi-platform reproducible environments.
12+
To start developing:
13+
14+
1. [Install Pixi](https://pixi.sh/)
15+
2. [Fork this repository on GitHub](https://github.com/carpentries-incubator/reproducible-ml-workflows/fork)
16+
3. Clone your fork and navigate to the top level of the repository
17+
4. Run
18+
19+
```
20+
pixi run start
21+
```
22+
23+
and then open up the served site in your local browser and carry on with development.
24+
3825
[workbench]: https://carpentries.github.io/sandpaper-docs/

0 commit comments

Comments
 (0)