Skip to content
Volentix Papers
Branch: master
Clone or download
Latest commit 5e2ec07 Apr 24, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
vdex-whitepaper
vespucci-whitepaper
volentix-green-paper
.gitignore
LICENSE
README.md
crowdin.yml

README.md

Volentix Papers

(c) 2019 Volentix, Inc. All rights reserved

This repository contains the LaTeX source code for the Volentix papers. The instructions to clone the repository and build the PDF using pandoc are described below.

Translation Guide

Crowdin

If you want to add new language, review/update existing translation or help to finish specific translations, you can join and do that by following link: https://crowdin.com/project/volentix-papers

Fast Build

OSX

  • brew install docker docker-machine
  • brew tap caskroom/cask
  • brew cask install virtualbox
  • docker-machine create --driver virtualbox default
  • eval $(docker-machine env default)
  • make

Docker Already Installed, Linux

(This is already in the Makefile. Just type make.)

  • docker build -t Volentix/papers .
  • docker run Volentix/papers/vdex-whitepaper/en-US/ > vdex-whitepaper.pdf

Manual Build

Currently the manual build instructions are for Ubuntu 16.04 or higher but may successfully build on other distributions. Pull requests to update the papers will be gladly accepted and reviewed.

Install Packages

sudo apt-get update
sudo apt install -y texlive-xetex pandoc python3-pip graphviz imagemagick
pip3 install matplotlib

Compile Images

There are several image files in the /img/ directory that are generated using the build file. The first time the build is done, and whenever the figures are updated, the images will need to be compiled.

./build.sh

Build PDF

Compile using pandoc

git clone https://github.com/Volentix/papers.git
cd papers/vdex-whitepaper/en-US
pandoc README.md --pdf-engine=xelatex -o vdex-whitepaper.pdf

After building, the pdf file will be output to vdex-whitepaper.pdf.

You can’t perform that action at this time.