Occam's offside rule.
npm install occam-offsideOccam's offside rule.
- Introduction
- Installation
- Examples
- Usage
- Building
- Contact
To come.
With npm:
npm install occam-offside
You can also clone the repository with Git...
git clone https://github.com/djalbat/occam-offside.git
...and then install the dependencies with npm from within the project's root directory:
npm install
You can also run a development server, see the section on building later on.
There is a small development server that can be run from within the project's directory with the following command:
npm start
The examples will then be available at the following URL:
http://localhost:8888
The source for the examples can be found in the src/example.js file and corresponding src/example folder. You are encouraged to try the examples whilst reading what follows. You can rebuild them on the fly with the following command:
npm run watch-debug
The development server will reload the page whenever you make changes.
One last thing to bear in mind is that this package is included by way of a relative rather than a package import. If you are importing it into your own application, however, you should use the standard package import.
To come.
Automation is done with npm scripts, have a look at the package.json file. The pertinent commands are:
npm run build-debug
npm run watch-debug
* james.smith@djalbat.com