Skip to content

Commit

Permalink
chore: tweak header
Browse files Browse the repository at this point in the history
  • Loading branch information
Joe-Heffer-Shef committed Jul 19, 2024
1 parent fef70f2 commit f1d1b31
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 5 deletions.
4 changes: 2 additions & 2 deletions episodes/introduction.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Why document code?"
title: "Introduction"
teaching: 10
exercises: 2
---
Expand All @@ -20,7 +20,7 @@ exercises: 2

::::::::::::::::::::::::::::::::::::::::::::::::

## Introduction
## Why document code?

No code is self-explanatory. It’s a tool we design, or, more often, a complex organism that develops as we use it, such as a library of functions used within a research team to perform certain kinds of analysis.

Expand Down
2 changes: 1 addition & 1 deletion episodes/readmes.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ exercises: 2

::::::::::::::::::::::::::::::::::::::::::::::::

## Introduction
## What is a README file?

A README file is the first thing a user sees when they find your software. It should give them an approachable overview of the package, define what’s possible to achieve with this code, and get them started on the right track to use the software effectively for their research.

Expand Down
2 changes: 0 additions & 2 deletions learners/setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,6 @@ The [R programming language](https://cran.rstudio.com/) is a statistical package
and data analysis. To interact with R, the most popular tool is
[RStudio Desktop](https://posit.co/download/rstudio-desktop/).

TODO online editors

:::::::::::::::: spoiler

### Windows
Expand Down

0 comments on commit f1d1b31

Please sign in to comment.