Next: Doc Directory, Up: Source Tree [Contents]
A.1 Root Directory
The root directory contains basic project files for common operations.
- index.js
This file is loaded automatically when ‘require( 'easejs' )’ is used.
- LICENSE
Contains the project license.
- Makefile
Invoked by the
make
command. Used for building ease.js.- package.json
Used by
npm
, a package manager for Node.js, to automate installation.- README.hacking
Useful information for those looking to modify/contribute to the project.
- README.md
Serves as a quick reference for the project, in markdown15 format. This format was chosen because it is displayed nicely on GitHub.
- README.todo
Incomplete tasks. Future direction of the project. If you’re looking to help out, take a look at this file to see what needs to be done. (See also the bug tracker at http://easejs.org/bugs).
These files will be discussed in further detail when they are actually used.