fix documentation and improve readme

2021-08-11 23:29:37 +02:00
parent efddf043e3
commit 1e9c9ba651
3 changed files with 47 additions and 4 deletions
@@ -9,7 +9,34 @@ Using the `remotes` package, this is easily installed via:
 ```r
 remotes::install_url("https://git.flavigny.de/christian/hateimparlament/archive/master.zip")
 ```
-If you want to build the vignettes, pass `build_vignettes = TRUE`.
+If you want to build the vignettes, pass `build_vignettes = TRUE`. This takes a long time and
+fails sometimes, if bundestag.de times out, since
+in the beginning the necessary records are neither fetched nor parsed.
+
+## Install with vignettes
+
+An alternative for building
+the vignettes is to clone the repository and build the vignettes manually, e.g. on Linux
+```
+git clone https://git.flavigny.de/christian/hateimparlament
+cd hateimparlament
+```
+Then open a `R` shell and do
+```
+devtools::load_all() # load package
+devtools::wd() # set working directory
+```
+Then fetch all records, read them and write the parsed tibbles to csv files.
+```
+fetch_all(create = TRUE)
+read_all() %>% repair() -> res
+write_to_csv(create = TRUE)
+```
+Now you can build the vignettes faster by using
+```
+devtools::install(build_vignettes = T)
+```
+This creates a `doc/` directory with all built vignettes.

 # Features