Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix and tutorial for using with R Markdown #10

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2019 J. Warner
Copyright (c) 2019 J. Warner, 2020 TruongSinh Tran-Nguyen

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
34 changes: 29 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,19 +5,43 @@ as long as you’re running an up-to-date LaTeX distribution.

## Quick start

### Using PdfLatex

You can clone this repo and try typesetting `jdf-starter.tex`
with the following commands:

biber jdf-starter
pdflatex jdf-starter
```sh
biber jdf-starter
pdflatex jdf-starter.tex
```

The result should look like `jdf-starter.pdf`.
* `biber` command generates used referenes from `references.bib`
* `pdflatex` command generates the final pdf

* `biber` command generates used referenes from `references.bib`
* `pdflatex` command generates the final pdf

### Using R Markdown

Assuming you already have [R](https://cran.r-project.org) installed, install dependencies:

```sh
Rscript ./install.r
```

You can then knit `jdf-starter.Rmd`
with the following command:

```sh
Rscript -e 'library(rmarkdown); rmarkdown::render("jdf-starter.Rmd")'
```

For [VS Code](https://code.visualstudio.com) user, see also
[R Markdown All in One](https://marketplace.visualstudio.com/items?itemName=TianyiShi.rmarkdown)
and [Pandoc Citer Extension](https://marketplace.visualstudio.com/items?itemName=notZaki.pandocciter)

## License

Copyright 2019 by Jake Warner.
Copyright 2019 by Jake Warner, 2020 TruongSinh Tran-Nguyen.

You have my permission to use JDF in whatever projects you wish,
whether commercial, personal, or otherwise, in whatever way you like.
Expand Down
Loading