Skip to content

Commit 4ca2c98

Browse files
authored
Update README.md
Small changes around sandpaper:serve()
1 parent a0250c8 commit 4ca2c98

File tree

1 file changed

+14
-10
lines changed

1 file changed

+14
-10
lines changed

_setting_up/README.md

Lines changed: 14 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -85,20 +85,24 @@ This installation was performed using Ubuntu 22.04 x64
8585
File->Open Project and then selecting the path where you cloned the repository.
8686
You may need to click on the R project file that is located in the repository directory.
8787
1. Run the following command to start sandpaper:
88-
```r
89-
sandpaper::build_lesson()
88+
```r
89+
sandpaper::serve()
9090
```
91-
1. You may notice errors that the package _**Pandoc**_ was not installed
92-
after running the sandpaper command. If so, install Pandoc then try building
93-
the lesson again. If successful, R which will launch your internet browser with the episode
91+
This will build the site and put it in the `Viewer` tab in RStudio. You can look at it in your
92+
browser by clicking on the "Open in New Window" icon.
93+
94+
If you notice errors that the package _**Pandoc**_ was not installed, try installing Pandoc and
95+
then try building the lesson again. If successful, R which will launch your internet browser with the episode.
96+
As you make edits and save the document you are working on, the site will be rebuilt.
9497

95-
Pandoc installation: https://pandoc.org/installing.html
96-
1. An alternative approach is to use the `serve` function
98+
**Alternative to sandpaper::serve**
99+
100+
The function `build_lesson` is very similar to
97101
```r
98-
sandpaper::serve()
102+
sandpaper::build_lesson()
99103
```
100-
Not only will this build the lesson and put the web page in RStudio's viewer,
101-
but it will also update live when you save any changes.
104+
except that it doesn't automatically build upon each save. If the page does not appear automatically in
105+
your browser, you may need to open it manually.
102106

103107
### On GitHub
104108
You can also preview your episodes once you have a Pull-Request.

0 commit comments

Comments
 (0)