Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
jmhogan authored Jun 20, 2024
1 parent dee3439 commit e3ef932
Showing 1 changed file with 3 additions and 30 deletions.
33 changes: 3 additions & 30 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,12 @@ Although the `config.yaml` states the life cycle stage as pre-alpha, **the templ

To use this template to start a new lesson repository,
make sure you're logged into Github.
Visit https://github.com/carpentries/workbench-template-md/generate
Visit https://github.com/cms-opendata-workshop/workbench-template-md/generate
and follow the instructions.
Checking the 'Include all branches' option will save some time waiting for the first website build
when your new repository is initialised.

If you have any questions, contact [@tobyhodges](https://github.com/tobyhodges)
If you have any questions for DPOA, ask on Mattermost!. If you have any questions for the carpentries developer, contact [@tobyhodges](https://github.com/tobyhodges)

## Configure a new lesson

Expand Down Expand Up @@ -48,34 +48,7 @@ complete the initial configuration of a new lesson repository built from this te
- `lesson`
- the life cycle of the lesson (e.g. `pre-alpha`)
- the human language the lesson is written in (e.g. `deutsch`)
1. **Adjust the
`CITATION.cff`, `CODE_OF_CONDUCT.md`, `CONTRIBUTING.md`, and `LICENSE.md` files**
as appropriate for your project.
- `CITATION.cff`:
this file contains information that people can use to cite your lesson,
for example if they publish their own work based on it.
You should [update the CFF][cff-sandpaper-docs] now to include information about your lesson,
and remember to return to it periodicallt, keeping it updated as your
author list grows and other details become available or need to change.
The [Citation File Format home page][cff-home] gives more information about the format,
and the [`cffinit` webtool][cffinit] can be used to create new and update existing CFF files.
- `CODE_OF_CONDUCT.md`:
if you are using this template for a project outside The Carpentries,
you should adjust this file to describe
who should be contacted with Code of Conduct reports,
and how those reports will be handled.
- `CONTRIBUTING.md`:
depending on the current state and maturity of your project,
the contents of the template Contributing Guide may not be appropriate.
You should adjust the file to help guide contributors on how best
to get involved and make an impact on your lesson.
- `LICENSE.md`:
in line with the terms of the CC-BY license,
you should ensure that the copyright information
provided in the license file is accurate for your project.
1. **Update this README with
[relevant information about your lesson](https://carpentries.github.io/lesson-development-training/collaborating-newcomers.html#readme)**
and delete this section.


[cff-home]: https://citation-file-format.github.io/
[cff-sandpaper-docs]: https://carpentries.github.io/sandpaper-docs/editing.html#making-your-lesson-citable
Expand Down

0 comments on commit e3ef932

Please sign in to comment.