Skip to content

Commit

Permalink
Fix typos
Browse files Browse the repository at this point in the history
  • Loading branch information
Joe-Heffer-Shef committed May 20, 2024
1 parent cd189c7 commit 9c6650a
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 3 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Research Sofware Documentation
# Research Software Documentation

This repository contains a course on documenting research software that has been created using [The Carpentries Workbench](https://carpentries.github.io/workbench).

## Course description

This course will introduce you to the different ways we can provide guidance to future users and maintainers of our code. These range from the very simple, just as leaving a few handy notes, to the complex, generating a reference website that includes tutorials and a detailed reference. The right approach for your projects will probably be a blend of these, and depends on the context and your audience.
This course will introduce you to the different ways we can provide guidance to future users and maintainers of our code. These coding best practices range from the very simple, such as leaving a few handy notes, to the complex, generating a reference website that includes tutorials and a detailed reference. The right approach for your projects will probably be a blend of these, and depends on the context and your audience.

## Why document software?

Expand Down
4 changes: 3 additions & 1 deletion index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,9 @@
site: sandpaper::sandpaper_site
---

This course will introduce you to the different ways we can provide guidance to future users and maintainers of our code. These range from the very simple, just as leaving a few handy notes, to the complex, generating a reference website that includes tutorials and a detailed reference. The right approach for your projects will probably be a blend of these, and depends on the context and your audience.
## Course description

This course will introduce you to the different ways we can provide guidance to future users and maintainers of our code. These coding best practices range from the very simple, such as leaving a few handy notes, to the complex, generating a reference website that includes tutorials and a detailed reference. The right approach for your projects will probably be a blend of these, and depends on the context and your audience.

## Why document software?

Expand Down

0 comments on commit 9c6650a

Please sign in to comment.