Skip to content

Commit f6d758a

Browse files
committed
Update README.md
1 parent 584e488 commit f6d758a

File tree

1 file changed

+17
-4
lines changed

1 file changed

+17
-4
lines changed

README.md

Lines changed: 17 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,10 @@ A short course on the basics of software testing in Python using the `pytest` li
44

55
This lesson uses [The Carpentries Workbench][workbench] template.
66

7+
It is derived from the [FAIR2 for Research Software](https://fair2-for-research-software.github.io/)
8+
training course [python-testing-for-research](https://github.com/FAIR2-for-research-software/python-testing-for-research)
9+
by the University of Sheffield.
10+
711
## Course Description
812

913
Whether you are a seasoned developer or just write the occasional script, it's important to know that your code does what you intend, and will continue to do so as you make changes.
@@ -18,7 +22,7 @@ This course seeks to provide you with conceptual understanding and the tools you
1822
- Running a test suite & understanding outputs
1923
- Best practices
2024
- Testing for errors
21-
- Testing data structures
25+
- Testing floating point data
2226
- Fixtures
2327
- Parametrisation
2428
- Testing file outputs
@@ -30,18 +34,27 @@ Contributions are welcome, please refer to the [contribution guidelines](CONTRIB
3034

3135
### Build the lesson locally
3236

33-
To render the lesson locally, you will need to have [R][r] installed. Instructions for using R with the Carpentries template is [available](https://carpentries.github.io/workbench/#installation) but some additional setps have been taken to make sure the enivronment is reproducible using the [`{renv}`](https://rstudio.github.io/renv/articles/renv.html) package and an `renv.lockfile` is included which allows the environment to be re-created along with dependencies.
37+
To render the lesson locally, you will need to have [R][r] installed.
38+
Instructions for using R with the Carpentries template is available on the
39+
[Carpentries website](https://carpentries.github.io/workbench/#installation).
40+
We recommend using the
41+
[`{renv}`](https://rstudio.github.io/renv/articles/renv.html) package.
42+
43+
After cloning the repository, you can set up `renv` and install all packages with:
3444

35-
After cloning the repository, you can set up the `renv` and install all packages with:
3645
``` r
37-
renv::restore()
46+
renv::init()
3847
# Optionally update packages
3948
renv::update()
4049
```
4150
Once you have installed the dependencies, you can render the pages locally by starting R in the project root and running:
51+
4252
``` r
4353
sandpaper::serve()
4454
```
55+
56+
When building the site subsequently, you may need to run `renv::activate()` first.
57+
4558
This will build the pages and start a local web-server in R and open it in your browser. These pages are "live" and will respond to local file changes if you save them.
4659

4760
[git]: https://git-scm.com

0 commit comments

Comments
 (0)