Skip to content

Commit

Permalink
Simplify readme and point to documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
tmcw committed Jul 3, 2012
1 parent 2d7c45d commit c7d0d1f
Showing 1 changed file with 4 additions and 20 deletions.
24 changes: 4 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,3 @@
_ _ _
| | | | (_)
_ __ ___ ___ __| | ___ ___| |_ _ __ ___ __ _ _ __ ___ _ ___
| '_ ` _ \ / _ \ / _` |/ _ \/ __| __| | '_ ` _ \ / _` | '_ \/ __| | / __|
| | | | | | (_) | (_| | __/\__ \ |_ | | | | | | (_| | |_) \__ \ | \__ \
|_| |_| |_|\___/ \__,_|\___||___/\__| |_| |_| |_|\__,_| .__/|___/ | |___/
| | _/ |
|_| |__/

Modest Maps JS is a BSD-licensed display and interaction library for tile-based
maps in Javascript.

Expand All @@ -15,23 +6,16 @@ library for discriminating designers and developers who want to use interactive
maps in their own projects. Modest Maps provides a core set of features in a
tight, clean package, with plenty of hooks for additional functionality.

Though Modest Maps JS is in its infancy it's derived from our trusty Python and
Actionscript code that has served us well for years. The best place to see it
in action today is Walking Papers, at http://walkingpapers.org

# Usage:

See `examples/` and [the wiki home page](https://github.com/stamen/modestmaps-js/wiki)
for ideas on how to start out using Modest Maps.
# [Documentation](https://github.com/modestmaps/modestmaps-js/wiki)

# Building
## Building

This package includes a copy of [YUICompressor](http://developer.yahoo.com/yui/compressor/),
which requires a version of Java on your system. To create a new build of
Modest Maps (only necessary for development), run `make` from the root
directory.

# Developing with npm:
## Developing with npm:

Modest Maps includes a `package.json` file to guide usage of its code on the
server-side, and to handle certain dependencies.
Expand All @@ -41,7 +25,7 @@ you'll need [npm](http://npmjs.org/):

npm install --dev

# Tests
## Tests

Tests require `expresso` to be installed by `npm`, as noted above. To run tests,

Expand Down

0 comments on commit c7d0d1f

Please sign in to comment.