The tea white paper is a semantically versioned, Markdown document with mathematical representations embedded as LaTeX. New releases are compiled to .pdf with Pandoc before being published here at GitHub.

tea/white-paper 1.0.3

Contributing

If you have general feedback, please open a discussion thread.

If you have edits please refer to our project-wide contribution guidelines. Then you can either:

Edit [white-paper.md] right here on GitHub. When you submit your pull request our CI will attach the pdf to the PR.
Or you can build the white paper on your own computer:
```
make   #=> ./tea.white-paper.pdf
```

Dependencies

Source these yourself or use tea: sh <(curl tea.xyz).

Project	Version
pandoc.org	^2.18
pandoc.org/crossref	^0.3
gnome.org/librsvg	^2.54

Translate

We build, publish and feature full PDFs of all translations at tea.xyz.

Fork teaxyz/white-paper

Then in your terminal:

$ export LANG=…          # https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes
$ export USER=…          # your github
$ export VERSION=$(git describe --abbrev=0) # latest version tag  
$ git clone https://github.com/${USER}/white-paper tea-white-paper
…
$ cd tea-white-paper
$ git checkout -b i18n/${LANG} ${VERSION}
…
$ mkdir -p i18n/${LANG}
$ cp white-paper.md metadata.yml i18n/${LANG}

Translate ./i18n/${LANG}/metadata.yml

To ./i18n/${LANG}/metadata.yml append:

lang: …       # https://pandoc.org/MANUAL.html#language-variables
dir: ltr      # language direction; ltr:left-to-right or rtl:right-to-left
header-includes:
  - \fancyfoot[L]{${VERSION}+${LANG}}   # expand these variables!
translator:
  - Your Fullname

Translate ./i18n/${LANG}/white-paper.md

Commit translation to git and push to GitHub:

git add i18n/${LANG}/*
git commit -m "add ${LANG} translation"
git push origin i18n/${LANG}

Create a pull request:

open https://github.com/teaxyz/white-paper/compare/main...${USER}:white-paper:i18n/${LANG}

(Optional) Preview your work:
```
make tea.white-paper_${LANG}.pdf
```

Maintenance

Set Version