README.qmd

---
format: gfm
---

# {{< meta tagline >}}

{{< include /includes/_badges.qmd >}}

## Description

<!-- TODO: Very brief intro, motivation, and overview of workshop. -->

This repository contains the lesson, lecture, and assignment material for the
workshop, including the website source files and other associated workshop
administration and development files. For more detail on the workshop, check out
the [welcome page]({{< meta links.site >}}).

::: callout-tip
This workshop repository was generated from the
[`template-workshop`](https://github.com/rostools/template-workshop) rostools
template.
:::

## Instructional Design

The lectures and lessons in this workshop are designed to be presented primarily
with a participatory live-coding approach. This involves an teacher typing and
running code in an editor or similar platform in front of the class, while the
class follows along using their own computers. Exercises 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 workshop website for participants to refer to during lectures.

## Lesson content

The teaching material is found mainly in these locations:

- `index.Rmd`: Contains the overview of the workshop.
- `overview/` folder: Contains the files that give an overview to the workshop,
  such as the syllabus and schedule.
- `pre-workshop/`: Contains the files needed before the workshop, like the
  pre-workshop tasks.
- `sessions/`: Contains the files used during the workshop (e.g. code-along
  material).
- `appendix/`: Contains the files used to support the workshop, such as code of
  conduct, changelog, contributing guides, and instructions for teachers.
- `slides/`: Contains the lecture slides that are rendered into HTML slides from
  Markdown.

The website is generated with [Quarto](https://quarto.org/), so it follows the
file and folder structure conventions from that package.

## Contributing

If you are interested in contributing to the workshop material, please refer to
the [contributing guidelines](CONTRIBUTING.md). For guidelines on how to be a
helper or teacher, check out the [For
teachers](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 this
project, you agree to abide by its terms.

<!-- TODO: Unhide after having contributors -->

::: content-hidden
### Contributors

{{< include /includes/_contributors.qmd >}}
:::

## Licensing

This project is licensed under the [CC-BY-4.0 License](LICENSE.md).

## Re-use

The workshop is largely designed to be taught in the order given, as each
session builds off of the previous ones. The easiest way to use this material is
to use it as-is, making use of the tips and instructions 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.

To help with general admin tasks of running the workshop, there is the
[samwise](https://github.com/rostools/samwise) R package.

## Changelog

For a list of changes, see our [changelog](CHANGELOG.md) page.

::: content-hidden
### How to cite the material

Please cite the material as:

> TODO: Update when the workshop is published.

Or as BibTeX:

TODO: Update when the workshop is published.
:::