| 1 | [](https://travis-ci.org/cdibbs/folproof)
|
| 2 |
|
| 3 | ## Demo
|
| 4 | Take it for a test drive: [cdibbs.github.io/folproof](https://cdibbs.github.io/folproof)
|
| 5 |
|
| 6 | ## Building
|
| 7 | 1. If you don't have node and npm installed, please install it.
|
| 8 | * Visit [here](https://github.com/joyent/node/wiki/Installing-Node.js-via-package-manager), for more details.
|
| 9 | 2. Run `npm install` to install the libraries FOLProof needs.
|
| 10 | 3. Run `make`.
|
| 11 |
|
| 12 | ## Installing (Optional)
|
| 13 | If you'd like to run FOLProof in a shell, then proceed, here:
|
| 14 |
|
| 15 | 1. Install the build dependencies (node, npm, etc).
|
| 16 | 2. Within the folproof root directory, run `sudo npm -g install`.
|
| 17 | * This should install shell dependencies, like nomnom and path.
|
| 18 |
|
| 19 | ## Running
|
| 20 | There are several ways to run FOLProof:
|
| 21 |
|
| 22 | 1. From the shell
|
| 23 | * After installation: type `folproof [your-proof].fol`, from anywhere.
|
| 24 | * Without installation: type `node cli.js [your-proof].fol`, from within the folproof directory.
|
| 25 | 2. From the web
|
| 26 | * Please look in the included index.html for an example of how to use FOLProof in a website.
|
| 27 | * You can test the included index.html [at the demo site](https://cdibbs.github.io/folproof).
|
| 28 |
|
| 29 | ## Architecture Overview
|
| 30 | * folproof-parser.js - built automatically from ./src/parser/folproof-parser.jison and folproof-parser.jisonlex
|
| 31 | * folproof-web.js - renders proof ASTs to HTML. Requires JQuery
|
| 32 | * folproof-verifier.js - verifies proofs from ASTs (built from /src/*.js)
|
| 33 | * cli.js - a short script to run verifier.js, from within a shell.
|
| 34 | * index.html - provides a test interface
|
| 35 |
|