Crisp Document Format
Each of these pieces are written in coffeescript, intended to be run in NodeJS. Grunt is used to manage building everything.
This software uses the standard node package manager
system for installing and managing dependencies. Assuming you have node
and npm installed, getting everything installed is as simple as running
npm install in the root of this repo.
The code and resources in this repo are organized as follows:
This very file you're reading right now.
Very simple examples of CDF applications. They are not very useful, but are intended to give examples of both how larger applications could be structured, and demonstrate how each of three parts of the CDF system work together.
Reference documents, most importantly the reference definition of the CDF
document format. Docs are written in markdown (from the
subdirectory) and compiled into HTML (in the
GPL3 license, which covers all of the code in the
The NPM package definition for all the code and dependencies used in this project. For those unfamiliar with how to use this file, see the NPM reference documentation.
The source code used for the project. For each section, the original,
commented coffeescript is included in the
This code can be used directly with the included parser command line too.
You can use this with
node src/parser/js/parser.js --in <input file>.
You can use the
--help flag to see other available options.
The proxy is started by using the
src/proxy/js/proxy.js script. This
script accepts several arguments / flags, which are described with the