Commit d94cbdad authored by lorenzwalthert's avatar lorenzwalthert
Browse files

refine readme.

parent 48dca41e
...@@ -52,22 +52,27 @@ creator of this template. ...@@ -52,22 +52,27 @@ creator of this template.
**How this template works** **How this template works**
There ar different directories in this template. There are different directories in this template. We canuse the bash command
tee to show the output
```{bash} ```{bash, include = knitr::is_html_output()}
tree -d -L 2 tree -d -L 2
``` ```
* _book: Contains the compilied book, e.g. a PDF or html version. ```{bash, include = !knitr::is_html_output()}
* _bib: Contains bibtex reference data bases. tree -d -L 2 --charset unicode
```
* _book: Contains the compiled book, e.g. a PDF or html version.
* _bib: Contains BibTeX reference data bases.
* figure: Contains figures you created from your (R) code in the rmd source. * figure: Contains figures you created from your (R) code in the rmd source.
* images: Put images you want to include in your thesis in tis folder. * images: Put images you want to include in your thesis in this folder.
* pdf: Put PDFs you want to include in your thesis in tis folder. * pdf: Put PDFs you want to include in your thesis in this folder.
* rmd: The source folder of thesis. When you build a book, the following * rmd: The source folder of thesis. When you build a book, the following
happens: By default, all rmd files in this folder get merged into one big happens: By default, all rmd files in this folder get merged into one big
rmd file, according to their name. We suggest to use one file per chapter. rmd file, according to their name. We suggest to use one file per chapter.
Then, the file containing all the rmd sources will get processed by knitr and Then, the file containing all the rmd sources will get processed by knitr and
later by pandoc. later by Pandoc.
* style: Latex .sty files. Taken from the sfs LaTeX template. * style: Latex .sty files. Taken from the sfs LaTeX template.
* tex: All tex data, most importantly, the sfs LaTeX template itself. Note that * tex: All tex data, most importantly, the sfs LaTeX template itself. Note that
the abstract, preface, epilogue, summary, notation are still in tex, i.e. the abstract, preface, epilogue, summary, notation are still in tex, i.e.
...@@ -79,9 +84,9 @@ tree -d -L 2 ...@@ -79,9 +84,9 @@ tree -d -L 2
Furthermore, we want to highlight a few files in the root directory of the Furthermore, we want to highlight a few files in the root directory of the
project: project:
* DESCRIPTION: You can use it to delcare dependent packages of your thesis in * DESCRIPTION: You can use it to declare dependent packages of your thesis in
the `Imports:` field. If someone want's to rebuild you thesis from scratch, the `Imports:` field. If someone want's to rebuild you thesis from scratch,
the can use `remotes::install_deps()` to safisfy all R package dependencies. the can use `remotes::install_deps()` to satisfy all R package dependencies.
* index.R: Contains a YAML header where a few important variables are defined. * index.R: Contains a YAML header where a few important variables are defined.
You can also put markdown below the HEADER. You can also put markdown below the HEADER.
* README.(R)md This document. * README.(R)md This document.
...@@ -91,12 +96,12 @@ project: ...@@ -91,12 +96,12 @@ project:
This is obviously a very short introduction to the template and it is in no way This is obviously a very short introduction to the template and it is in no way
comprehensive. To learn more about bookdown, we encourage the reader to have comprehensive. To learn more about bookdown, we encourage the reader to have
a look at the [bookdown guide](https://bookdown.org/yihui/bookdown/) as well a look at the [bookdown guide](https://bookdown.org/yihui/bookdown/) as well
as searching through stackoverflow / Google for particular questions. In as searching through stack overflow / Google for particular questions. In
addition, inspect the different files in this repo, in particular the ones addition, inspect the different files in this repo, in particular the ones
in the rmd directory to develop a deeper understanding of the template. in the rmd directory to develop a deeper understanding of the template.
As of early 2018, this template is still in alpha testing phase, so you may As of early 2018, this template is still in alpha testing phase, so you may
experience unexpected behaviour. Please file an issue on the git repository experience unexpected behavior. Please file an issue on the git repository
where you have obtained the source of this template in case where you have obtained the source of this template in case
you are stuck for some time with a problem or if you found a solution to a you are stuck for some time with a problem or if you found a solution to a
problem you believe others are likely to encounter in the future. We want to problem you believe others are likely to encounter in the future. We want to
......
...@@ -39,42 +39,44 @@ of the creator of this template. ...@@ -39,42 +39,44 @@ of the creator of this template.
**How this template works** **How this template works**
There ar different directories in this template. There are different directories in this template. We canuse the bash
command tee to show the output
``` bash ``` bash
tree -d -L 2 tree -d -L 2 --charset unicode
#> . #> .
#> ├── _book #> |-- _book
#> │   ├── figures #> | |-- figures
#> │   ├── libs #> | |-- libs
#> │   ├── man #> | |-- man
#> │   └── thesis_SfS_files #> | `-- thesis_SfS_files
#> ├── _bookdown_files #> |-- _bookdown_files
#> │   └── thesis_SfS_files #> | `-- thesis_SfS_files
#> ├── bib #> |-- bib
#> ├── figure #> |-- figure
#> ├── figures #> |-- figures
#> ├── images #> |-- images
#> │   └── auto #> | `-- auto
#> ├── pdf #> |-- pdf
#> ├── rmd #> |-- rmd
#> ├── style #> |-- style
#> └── tex #> `-- tex
#> #>
#> 16 directories #> 16 directories
``` ```
- \_book: Contains the compilied book, e.g. a PDF or html version. - \_book: Contains the compiled book, e.g. a PDF or html version.
- \_bib: Contains bibtex reference data bases. - \_bib: Contains BibTeX reference data bases.
- figure: Contains figures you created from your (R) code in the rmd - figure: Contains figures you created from your (R) code in the rmd
source. source.
- images: Put images you want to include in your thesis in tis folder. - images: Put images you want to include in your thesis in this
- pdf: Put PDFs you want to include in your thesis in tis folder. folder.
- pdf: Put PDFs you want to include in your thesis in this folder.
- rmd: The source folder of thesis. When you build a book, the - rmd: The source folder of thesis. When you build a book, the
following happens: By default, all rmd files in this folder get following happens: By default, all rmd files in this folder get
merged into one big rmd file, according to their name. We suggest to merged into one big rmd file, according to their name. We suggest to
use one file per chapter. Then, the file containing all the rmd use one file per chapter. Then, the file containing all the rmd
sources will get processed by knitr and later by pandoc. sources will get processed by knitr and later by Pandoc.
- style: Latex .sty files. Taken from the sfs LaTeX template. - style: Latex .sty files. Taken from the sfs LaTeX template.
- tex: All tex data, most importantly, the sfs LaTeX template itself. - tex: All tex data, most importantly, the sfs LaTeX template itself.
Note that the abstract, preface, epilogue, summary, notation are Note that the abstract, preface, epilogue, summary, notation are
...@@ -86,10 +88,10 @@ tree -d -L 2 ...@@ -86,10 +88,10 @@ tree -d -L 2
Furthermore, we want to highlight a few files in the root directory of Furthermore, we want to highlight a few files in the root directory of
the project: the project:
- DESCRIPTION: You can use it to delcare dependent packages of your - DESCRIPTION: You can use it to declare dependent packages of your
thesis in the `Imports:` field. If someone want’s to rebuild you thesis in the `Imports:` field. If someone want’s to rebuild you
thesis from scratch, the can use `remotes::install_deps()` to thesis from scratch, the can use `remotes::install_deps()` to
safisfy all R package dependencies. satisfy all R package dependencies.
- index.R: Contains a YAML header where a few important variables are - index.R: Contains a YAML header where a few important variables are
defined. You can also put markdown below the HEADER. defined. You can also put markdown below the HEADER.
- README.(R)md This document. - README.(R)md This document.
...@@ -100,12 +102,12 @@ This is obviously a very short introduction to the template and it is in ...@@ -100,12 +102,12 @@ This is obviously a very short introduction to the template and it is in
no way comprehensive. To learn more about bookdown, we encourage the no way comprehensive. To learn more about bookdown, we encourage the
reader to have a look at the [bookdown reader to have a look at the [bookdown
guide](https://bookdown.org/yihui/bookdown/) as well as searching guide](https://bookdown.org/yihui/bookdown/) as well as searching
through stackoverflow / Google for particular questions. In addition, through stack overflow / Google for particular questions. In addition,
inspect the different files in this repo, in particular the ones in the inspect the different files in this repo, in particular the ones in the
rmd directory to develop a deeper understanding of the template. rmd directory to develop a deeper understanding of the template.
As of early 2018, this template is still in alpha testing phase, so you As of early 2018, this template is still in alpha testing phase, so you
may experience unexpected behaviour. Please file an issue on the git may experience unexpected behavior. Please file an issue on the git
repository where you have obtained the source of this template in case repository where you have obtained the source of this template in case
you are stuck for some time with a problem or if you found a solution to you are stuck for some time with a problem or if you found a solution to
a problem you believe others are likely to encounter in the future. We a problem you believe others are likely to encounter in the future. We
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment