ashatora/openlayers
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Updated Developer Guide (markdown)

twpayne
2013-03-22 05:03:02 -07:00
parent 1473a69839
commit 869712c6ff
1 changed files with 7 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
Developer-Guide.md

@@ -34,14 +34,12 @@ The minimum requirements are:
The executables `git`, `gjslint`, `java`, `jar`, `python`, and `phamtomjs` The executables `git`, `gjslint`, `java`, `jar`, `python`, and `phamtomjs`
should be in your `PATH`. should be in your `PATH`.
Optionally, you can also install JSDoc 3, version 3.1.1. Installing JSDoc 3 is Optionally, you can also install JSDoc 3. Installing JSDoc 3 is necessary
necessary if you want to run the full integration suite. if you want to run the full integration suite.
To get JSDoc 3.1.1 from GitHub: To get JSDoc from GitHub:
$ git clone git://github.com/jsdoc3/jsdoc.git $ git clone git://github.com/jsdoc3/jsdoc.git
$ cd jsdoc
$ git checkout v3.1.1
Again, the `jsdoc` executable, located at the root of `jsdoc` repository, Again, the `jsdoc` executable, located at the root of `jsdoc` repository,
should be in your `PATH`. should be in your `PATH`.
@@ -54,7 +52,8 @@ For that go to your ol3 fork's Service Hooks page and set up the Travis hook.
## Working with the build tool ## Working with the build tool
As an ol3 developer you will need to use the `build.py` Python script. This is As an ol3 developer you will need to use the `build.py` Python script. This is
the script to use to run the linter, the compiler, the tests, etc. the script to use to run the linter, the compiler, the tests, etc. Windows users
can use `build.cmd` which is a thin wrapper around `build.py`.
The `build.py` script is equivalent to a Makefile. It is actually based on The `build.py` script is equivalent to a Makefile. It is actually based on
[pake](https://github.com/twpayne/pake/), which is a simple implementation of [pake](https://github.com/twpayne/pake/), which is a simple implementation of
@@ -165,7 +164,7 @@ section provides explanations related to adding examples.
The examples are located in the `examples` directory. Adding a new example The examples are located in the `examples` directory. Adding a new example
implies creating two files in this directory, an `.html` file and a `.js` file. implies creating two files in this directory, an `.html` file and a `.js` file.
See `examples/simplae.html` and `examples/simple.js` for instance. See `examples/simple.html` and `examples/simple.js` for instance.
The `.html` file needs to include a script tag with The `.html` file needs to include a script tag with
`loader.js?id=<example_name>` as its `src`. For example, if the two files for `loader.js?id=<example_name>` as its `src`. For example, if the two files for
@@ -202,7 +201,7 @@ statements in the code of the examples.
We follow http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html We follow http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
for the formatting of commit messages. for the formatting of commit messages.
Basically, here's what a Git commit message should look like: Git commit message should look like:
Header line: explaining the commit in one line Header line: explaining the commit in one line