From c1d68cb16698250313ab8caed9b6132477f8732a Mon Sep 17 00:00:00 2001 From: Tom MacWright Date: Thu, 26 May 2011 11:37:09 -0400 Subject: [PATCH] Updating README to be an introduction to docs, testing, and building as well. --- README | 20 -------------------- README.md | 48 ++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 48 insertions(+), 20 deletions(-) delete mode 100644 README create mode 100644 README.md diff --git a/README b/README deleted file mode 100644 index 5ede9c7..0000000 --- a/README +++ /dev/null @@ -1,20 +0,0 @@ - _ _ _ - | | | | (_) - _ __ ___ ___ __| | ___ ___| |_ _ __ ___ __ _ _ __ ___ _ ___ -| '_ ` _ \ / _ \ / _` |/ _ \/ __| __| | '_ ` _ \ / _` | '_ \/ __| | / __| -| | | | | | (_) | (_| | __/\__ \ |_ | | | | | | (_| | |_) \__ \ | \__ \ -|_| |_| |_|\___/ \__,_|\___||___/\__| |_| |_| |_|\__,_| .__/|___/ | |___/ - | | _/ | - |_| |__/ - -Modest Maps JS is a BSD-licensed display and interaction library for tile-based -maps in Javascript. - -Our intent is to provide a minimal, extensible, customizable, and free display -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 \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..ae3b26c --- /dev/null +++ b/README.md @@ -0,0 +1,48 @@ + _ _ _ + | | | | (_) + _ __ ___ ___ __| | ___ ___| |_ _ __ ___ __ _ _ __ ___ _ ___ + | '_ ` _ \ / _ \ / _` |/ _ \/ __| __| | '_ ` _ \ / _` | '_ \/ __| | / __| + | | | | | | (_) | (_| | __/\__ \ |_ | | | | | | (_| | |_) \__ \ | \__ \ + |_| |_| |_|\___/ \__,_|\___||___/\__| |_| |_| |_|\__,_| .__/|___/ | |___/ + | | _/ | + |_| |__/ + +Modest Maps JS is a BSD-licensed display and interaction library for tile-based +maps in Javascript. + +Our intent is to provide a minimal, extensible, customizable, and free display +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. + +# 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: + +Modest Maps includes a `package.json` file to guide usage of its code on the +server-side, and to handle certain dependencies. + +To install developer dependencies - needed for documentation and tests - +you'll need [npm](http://npmjs.org/): + + npm install --dev + +# Tests + +Tests require `expresso` to be installed by `npm`, as noted above. To run tests, + + make tests