Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 49 lines (34 sloc) 2.056 kb
c1d68cb Updating README to be an introduction to docs, testing, and building …
Tom MacWright authored
1 _ _ _
2 | | | | (_)
3 _ __ ___ ___ __| | ___ ___| |_ _ __ ___ __ _ _ __ ___ _ ___
4 | '_ ` _ \ / _ \ / _` |/ _ \/ __| __| | '_ ` _ \ / _` | '_ \/ __| | / __|
5 | | | | | | (_) | (_| | __/\__ \ |_ | | | | | | (_| | |_) \__ \ | \__ \
6 |_| |_| |_|\___/ \__,_|\___||___/\__| |_| |_| |_|\__,_| .__/|___/ | |___/
7 | | _/ |
8 |_| |__/
9
10 Modest Maps JS is a BSD-licensed display and interaction library for tile-based
11 maps in Javascript.
12
13 Our intent is to provide a minimal, extensible, customizable, and free display
14 library for discriminating designers and developers who want to use interactive
15 maps in their own projects. Modest Maps provides a core set of features in a
16 tight, clean package, with plenty of hooks for additional functionality.
17
18 Though Modest Maps JS is in its infancy it's derived from our trusty Python and
19 Actionscript code that has served us well for years. The best place to see it
20 in action today is Walking Papers, at http://walkingpapers.org
21
22 # Usage:
23
24 See `examples/` and [the wiki home page](https://github.com/stamen/modestmaps-js/wiki)
25 for ideas on how to start out using Modest Maps.
26
27 # Building
28
29 This package includes a copy of [YUICompressor](http://developer.yahoo.com/yui/compressor/),
30 which requires a version of Java on your system. To create a new build of
31 Modest Maps (only necessary for development), run `make` from the root
32 directory.
33
34 # Developing with npm:
35
36 Modest Maps includes a `package.json` file to guide usage of its code on the
37 server-side, and to handle certain dependencies.
38
39 To install developer dependencies - needed for documentation and tests -
40 you'll need [npm](http://npmjs.org/):
41
42 npm install --dev
43
44 # Tests
45
46 Tests require `expresso` to be installed by `npm`, as noted above. To run tests,
47
48 make tests
Something went wrong with that request. Please try again.