This repository generates the corresponding lesson website from The Carpentries repertoire of lessons.
We welcome all contributions to improve the lesson! Maintainers will do their best to help you if you have any questions, concerns, or experience any difficulties along the way.
We'd like to ask you to familiarize yourself with our Contribution Guide and have a look at the [more detailed guidelines][lesson-example] on proper formatting, ways to render the lesson locally, and even how to write new episodes.
Please see the current list of issues for ideas for contributing to this repository. For making your contribution, we use the GitHub flow, which is nicely explained in the chapter Contributing to a Project in Pro Git by Scott Chacon. Look for the tag . This indicates that the maintainers will welcome a pull request fixing this issue.
There are some recommendations here for creating new lessons Carpentries: 10 things to know
The site can be built on a local machine after cloning the repo with:
make serve
if the build is successful, the server address (something like http://127.0.0.1:4000) will appear at the end of the print out.
May need to install software on the build machine (my version of Ruby needed to be updated).
Note: the gitignore file already keeps the build file from being committed - but we should be careful to keep that true in the future.
Current maintainer of this lesson is:
A list of contributors to the lesson can be found in AUTHORS
To cite this lesson, please consult with CITATION