https://github.com/mento-protocol/whitepaper
https://github.com/mento-protocol/whitepaper
Last synced: 4 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/mento-protocol/whitepaper
- Owner: mento-protocol
- Created: 2024-05-28T11:44:35.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-06-21T14:50:30.000Z (almost 2 years ago)
- Last Synced: 2025-01-02T15:50:45.720Z (over 1 year ago)
- Language: TeX
- Size: 3.64 MB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Mento Whitepaper
This repository host the Mento Whitepaper - a community effort that aims to give an overview over the Mento Protocol and its usecases.
## Development Setup
### Prerequisites
- LaTeX distribution (TeX Live recommended)
- Inkscape (for SVG conversion)
- VS Code with [LaTeX Workshop](https://marketplace.visualstudio.com/items?itemName=James-Yu.latex-workshop) extension
### Building
Open the project in VS Code. Saving any `.tex` file will automatically build both PDFs:
- `Mento_Whitepaper.pdf` - Standard version
- `Mento_Whitepaper_MiCAR.pdf` - MiCAR compliance version
Build artifacts are stored in `.build/` and ignored by git.
### Manual Build
```bash
latexmk -pdf -shell-escape -outdir=.build -jobname=Mento_Whitepaper main.tex
latexmk -pdf -shell-escape -outdir=.build -jobname=Mento_Whitepaper_MiCAR main_micar.tex
cp .build/*.pdf .
```
## Getting involved
The Whitepaper is written in LaTeX. Own branches and pull requests are very welcome. The GitHub user pushing changes has so far often made changes on request of other (often non-technical) members of the Mento community so there is no one-to-one correspondence of changes made and GitHub accounts related. If you want to get in contact with other community members, please consider joining our [Discord server](https://discord.mento.org).