Skip to content

Commit

Permalink
docs: 📝 update title and add license badge (#92)
Browse files Browse the repository at this point in the history
## Description

These changes are to align the title and subtitle in the `README` with
what we have agreed on in #40 and implemented in #57 .

While I was at it, I added a licence badge as well.

## Reviewer Focus

This PR needs a quick review. 

## Checklist

- [X] Ran spell-check
- [X] Rendered website locally

---------

Co-authored-by: Luke W. Johnston <[email protected]>
  • Loading branch information
signekb and lwjohnst86 authored Nov 8, 2024
1 parent 518c226 commit c2ad6ad
Showing 1 changed file with 7 additions and 6 deletions.
13 changes: 7 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
# Collaboration with Git and GitHub: A gentle introduction to a team-based collaborative workflow using Git and GitHub
# :cat2: Git for Collaborative Teams

[![](https://img.shields.io/badge/License-CC%20BY%204.0-lightgrey.svg)](https://creativecommons.org/licenses/by/4.0/)

## Description

Reproducibility and open scientific practices are increasingly being
This is an introductory course on team-based collaboration with Git and GitHub. In line with other [rostools](https://github.com/rostools) courses, Git for Collaborative Teams is designed with reproducibility and open scientific practices in mind. These practises are increasingly being
requested or required of scientists and researchers, but training on
these practices has not kept pace. This course intends to help bridge
that gap and covers the fundamentals and workflow of data analysis in R.
that gap and covers the fundamentals and workflow of working with Git and GitHub in a collaborative team setting.

This repository contains the lesson, lecture, and assignment material
for the course, including the website source files and other associated
Expand All @@ -19,11 +21,10 @@ page](https://cog-flow-intro.rostools.org).
The lectures and lessons in this course are designed to be presented
primarily with a participatory live-coding approach. This involves an
instructor typing and running code in
[RStudio](https://posit.co/products/open-source/rstudio/) in front of
[VS Code](https://code.visualstudio.com/) in front of
the class, while the class follows along using their own computers.
Challenges are interspersed in the lesson material, allowing
participants to collaboratively work on smaller coding problems for a
few minutes. All lesson materials are provided ahead of time on the
participants to collaboratively work on smaller exercises and problems. All lesson materials are provided ahead of time on the
course website for participants to refer to during lectures.

## Lesson content
Expand Down

0 comments on commit c2ad6ad

Please sign in to comment.