frenetic-lang/manual

Name: manual

Owner: The Frenetic Project

Description: Programmers Guide and other written materials

Created: 2015-10-20 19:00:36.0

Updated: 2018-04-09 10:22:32.0

Pushed: 2016-07-13 18:24:52.0

Homepage: null

Size: 6290

Language: TeX

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

Frenetic Manual

For the impatient: https://github.com/frenetic-lang/manual/blob/master/programmers_guide/frenetic_programmers_guide.pdf

Building From Source

The official documentation toolchain is LaTeX.
TeXLive 2015 (or later) package has everything you need to build.

• TeXLive for Windows installation instructions are at http://www.tug.org/texlive/acquire-netinstall.html
• TeXLive for Mac, or MacTeX, installation instructions are at https://tug.org/mactex/

Then use whatever IDE you're comfortable with (TeXshop, etc.) to run programmers_guide/frenetic_programmers_guide.tex. Alternatively, from the command line you can run:

 programmers_guide
ke

Testing Code From the Guide

All code in the Frenetic Programmers Guide can be tested with the automatic test harness. To run:

 programmers_guide/code/test
do python test_suite.py

The test takes about 15 minutes to run on a MacBook under Frenetic User VM.