Skip to content

Commit

Permalink
More info on building in the README.
Browse files Browse the repository at this point in the history
  • Loading branch information
moorepants committed May 31, 2024
1 parent fe91d67 commit 6c8bca2
Showing 1 changed file with 21 additions and 2 deletions.
23 changes: 21 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,30 @@
- subcaption is available for subfigures
- Use siunitx for units (note the kph custom definition)
- Jason has a zotero folder with the references and auto generates the bib
file from it. TOOD: Make a shared zotero folder so anyone can generate it.
Don't edit the bib file manually (until possibly the very end of writing).
file from it. Don't edit the bib file manually (until possibly the very end
of writing).

Uses this action to build the PDF: https://github.com/marketplace/actions/github-action-for-latex

View the latest PDF:

https://github.com/mechmotum/fall-probability-paper/blob/gh-pages/main.pdf

# Generating the bib file

Install Zotero and betterbibtex. Using this collection:

https://www.zotero.org/groups/966974/mechmotum/collections/44NW2M7I

export the bib file with betterbitex.

# Build Instructions

Install LaTeX, conda, and make, then:

```
conda env create -f fall-prob-paper-env.yml
conda activate fall-prob-paper
make figures
make
```

0 comments on commit 6c8bca2

Please sign in to comment.