Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: 📝 update README with specifics of this course #37

Merged
merged 2 commits into from
Sep 26, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 19 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# r-cubed: TODO TITLE <img src="_extensions/r3-theme/favicon.ico" align="right" height="100"/>
# Collaboration with Git and GitHub: A gentle introduction to a team-based collaborative workflow using Git and GitHub
lwjohnst86 marked this conversation as resolved.
Show resolved Hide resolved

## Description

Expand All @@ -11,7 +11,8 @@ This repository contains the lesson, lecture, and assignment material
for the course, including the website source files and other associated
course administration files.

For more detail on the course, check out the [welcome page]().
For more detail on the course, check out the [welcome
page](https://cog-flow-intro.rostools.org).

## Instructional Design

Expand All @@ -29,15 +30,15 @@ course website for participants to refer to during lectures.

The teaching material is found mainly in these locations:

- `index.Rmd`: Contains the overview of the course.
- `preamble/` folder: Contains the files necessary for use before the
- `index.Rmd`: Contains the overview of the course.
- `preamble/` folder: Contains the files necessary for use before the
course, for instance the syllabus, schedule, and pre-course tasks.
- `sessions/` folder: Contains the files used during the course (e.g.
- `sessions/` folder: Contains the files used during the course (e.g.
code-along material)
- `appendix/` folder: Contains the files used to support the course,
- `appendix/` folder: Contains the files used to support the course,
such as pre-course tasks, code of conduct, resources, and
instructions for instructors.
- `slides/`: The lecture slides are rendered into HTML slides from
- `slides/`: The lecture slides are rendered into HTML slides from
Markdown.

The website is generated from [Quarto](https://quarto.org/), so it
Expand All @@ -47,8 +48,8 @@ follows the file and folder structure conventions from that package.

If you are interested in contributing to the course material, please
refer to the [contributing guidelines](CONTRIBUTING.md). For guidelines
on how to be a helper or instructor, check out the [For
Instructors](https://r-cubed.rostools.org/for-instructors.html) page.
on how to be a helper or instructor, check out the [Teaching in
class](https://guides.rostools.org/instructors) page.

Please note that the project is released with a [Contributor Code of
Conduct](CODE_OF_CONDUCT.md). By contributing to or being involved in
Expand All @@ -63,19 +64,18 @@ found throughout this page. The only thing you might want to make as
your own would be the slides, however, they are also good enough to use
on their own too.

But if you want to customize a bit more, the best approach is to [fork
the repository]() into your own GitLab account and modify it to fit your
needs from there. The website is built automatically with GitHub Actions
and then published as a website through Netlify. More detail on how to
build your own website from the material is outside the scope of this
document but you can find more information on Quarto's
Since this is a CC-BY licensed course, you are free to take and modify
the content to fit your purposes (as long as appropriate attribution is
given). The website is built automatically with GitHub Actions and then
published as a website through Netlify. More detail on how to build your
own website from the material is outside the scope of this document but
you can find more information on Quarto's
[Publishing](https://quarto.org/docs/publishing/) page.

To help with general admin tasks of running the course, there is the
[r3admin](https://github.com/rostools/r3admin) R package. For details of
the license and acknowledgement of content used from sources, see the
[license](TODO) page of the website.
[r3admin](https://github.com/rostools/r3admin) R package.

<!--
### How to cite the material

Please cite the material as:
Expand All @@ -85,4 +85,4 @@ Please cite the material as:
Or as BibTeX:

TODO: Update

-->