diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 27 |
1 files changed, 27 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..c613b29 --- /dev/null +++ b/README.md @@ -0,0 +1,27 @@ +# Literature Review Template + +These are quarto and rmarkdown templates for research literature review. +They are meant to make reading, taking notes and keep track of your studies easy. + +## Getting Started + +### Dependencies + +* rmarkdown +* quarto +* curl + +### Executing program + +* How to run the program +* Step-by-step bullets +* use the scripts in `scripts/` to render the markdown files to pdf +``` +./scripts/rmd2pdf lit-review-template.rmd +./scripts/qmd2pdf lit-review-template.qmd +``` +* use `scripts/doi2bib` to generate the bibtex entry for a document given the doi +(this script simply prints the results, redirect it into your references and clean the key as needed) +``` +./scripts/doi2bib '11.1038/ng.2982' >> references.bib +``` |