Feel free to skip this section if you have no interest in building ease.js yourself. The build process is fast, and is unnecessary if using ease.js server-side.
- Prepare the script for client-side deployment [and testing]
- Generate the documentation (manual and API)
In fact, if you're using ease.js server-side with software such as Node.js, you do not need to build anything at all. You can simply begin using it.
The aforementioned are built using make. The process that is run will vary depending on your system. The command will read Makefile in the root directory and execute the associated command. The following are the targets available to you:
- Creates the build/ directory, where all output will be stored. This
is run automatically by any of the targets.
- Runs the combine tool to produce two
separate files: ease.js, which can be used to use ease.js within the
web browser, and ease-full.js, which permits both using ease.js and
running the unit tests within the browser. The output is stored in the
The unit tests can be run by opening the build/browser-test.html file in your web browser.
- Runs combine and minifies the resulting combined files. These
files are output in the build/ directory and are useful for
distribution. It is recommended that you use the minified files in
- Run unit tests. This will first perform the combine process and
will also run the tests for the combined script, ensuring that it was
Unit tests will be covered later in the chapter.
- Generates documentation. Currently, only the manual is build. API
documentation will be added in the near future. The resulting documentation
will be stored in build/doc/. For your convenience, the manual is
output in the following forms: PDF, HTML (single page), HTML (multiple
pages) and plain text.
In order to build the documentation, you must have Texinfo installed. You likely also need LaTeX installed. If you are on a Debian-based system, for example, you will likely be able to run the following command to get started:
$ sudo apt-get install texlive texinfo
- Installs info documentation. Must first build doc-info. After
installation, the manual may be viewed from the command line with:
- Removes everything from the system that was installed with make
- Runs all targets, except for clean, install and uninstall.
- Cleans up after the build process by removing the build/ directory.
If you do not want to build ease.js yourself, you are welcome to download the pre-built files.