]> gitweb.michael.orlitzky.com - dead/census-tools.git/blob - jsroute/README
Added a readme for jsroute.
[dead/census-tools.git] / jsroute / README
1 The jsroute sub-project allows us to use Google Maps from the command
2 line. To do this, we require the env-js Javascript library. A remote
3 reference, called a "submodule,"[1] has been created in the
4 census-tools repository and points to env-js. To initialize/update it,
5 run,
6
7 git submodule init
8 git submodule update
9
10 Those two commands will initialize the submodule, and check it out
11 within the lib/env-js directory. Now that env-js is present, you'll
12 need to build it. There are some prerequisites for this; in
13 particular, a Java runtime[2] and the Ant[3] build tool. If you are
14 running Linux, I promise that both of these are available through your
15 package manager.
16
17 With the prerequisites installed, simply run 'make env-js' from within
18 the 'lib' directory. This will change into the env-js directory, and
19 run 'ant concat' which builds the library. With that complete, you can
20 use jsroute.
21
22 Just run ./jsroute from within this directory to display its usage.
23
24
25 [1] http://book.git-scm.com/5_submodules.html
26 [2] http://java.com/en/download/index.jsp
27 [3] http://ant.apache.org/