|
2 | 2 |
|
3 | 3 | A short course on the basics of software testing in Python using the `pytest` library. |
4 | 4 |
|
5 | | -This lesson uses [The Carpentries Workbench][workbench] template. |
| 5 | +This lesson uses [The Carpentries Workbench](https://carpentries.github.io/workbench/) template. |
6 | 6 |
|
7 | 7 | ## Course Description |
8 | 8 |
|
@@ -33,27 +33,27 @@ Contributions are welcome, please refer to the [contribution guidelines](CONTRIB |
33 | 33 | that you adhere to the [Code of Conduct](CODE_OF_CONDUCT.md). |
34 | 34 |
|
35 | 35 | ### Build the lesson locally |
36 | | - |
37 | | -To render the lesson locally, you will need to have [R][rlang] installed. Instructions for using R with the Carpentries |
38 | | -template is [available](https://carpentries.github.io/workbench/#installation) but some additional setps have been |
39 | | -taken to make sure the environment is reproducible using the |
| 36 | +<!-- markdownlint-disable MD053 --> |
| 37 | +To render the lesson locally, you will need to have [R](https://www.r-project.org/) installed. Instructions for using |
| 38 | +R with the Carpentries template is [available](https://carpentries.github.io/workbench/#installation) but some |
| 39 | +additional setps have been taken to make sure the environment is reproducible using the |
40 | 40 | [`{renv}`](https://rstudio.github.io/renv/articles/renv.html) package and an `renv.lockfile` is included which allows |
41 | 41 | the environment to be re-created along with dependencies. |
42 | 42 |
|
43 | 43 | After cloning the repository, you can set up the `renv` and install all packages with: |
44 | 44 |
|
| 45 | +```r |
45 | 46 | renv::restore() |
46 | 47 |
|
47 | 48 | renv::update() |
48 | | - |
49 | 49 | ``` |
50 | 50 |
|
51 | 51 | Once you have installed the dependencies, you can render the pages locally by starting R in the project root and |
52 | 52 | running: |
53 | | -``` r |
| 53 | + |
| 54 | +```r |
54 | 55 | sandpaper::serve() |
| 56 | +``` |
| 57 | + |
55 | 58 | This will build the pages and start a local web-server in R and open it in your browser. These pages are "live" and |
56 | 59 | will respond to local file changes if you save them. |
57 | | -
|
58 | | -[rlang]: https://www.r-project.org/ |
59 | | -[workbench]: https://carpentries.github.io/workbench/ |
0 commit comments