Skip to content

Commit

Permalink
update readme for v0.7.23 release
Browse files Browse the repository at this point in the history
  • Loading branch information
Dane Springmeyer committed Oct 31, 2013
1 parent 34a6ae0 commit 9b78046
Show file tree
Hide file tree
Showing 31 changed files with 5 additions and 1,976 deletions.
41 changes: 5 additions & 36 deletions README.md
Expand Up @@ -41,19 +41,15 @@ map.load('./examples/stylesheet.xml', function(err,map) {
});
```

Note: to run these examples locally first do:

export NODE_PATH=./lib:${NODE_PATH}

For more sample code see 'examples/README.md'
For more sample code see https://github.com/mapnik/node-mapnik-sample-code


## Depends

* Node v0.6 or v0.8
* Node >v0.6.13 and < v0.11
* Mapnik 2.x

Mapnik 2.2.x is targeted, but 2.1.x and 2.0.x is also supported.
Mapnik 2.2.x is targeted, but 2.1.x and 2.0.x are also supported.

This means that if you are running the Mapnik 2.2 series (current unreleased master) you must be running at least [0eddc2b5a0](https://github.com/mapnik/mapnik/commit/eebc8cc73eb18903b07e3b3e0757c11925962124).

Expand All @@ -73,10 +69,9 @@ To install node-mapnik locally for development or testing do:

git clone git://github.com/mapnik/node-mapnik.git
cd node-mapnik
./configure
make
npm install

Or set NODE_PATH to test importing:
Set NODE_PATH to test importing:

export NODE_PATH=./lib
node -e "require.resolve('mapnik')"
Expand All @@ -89,44 +84,18 @@ The above will install node-mapnik locally in a node_modules folder. To install

npm install -g mapnik


## Quick rendering test

To see if things are working try rendering a world map with the sample data

From the source checkout root do:

export NODE_PATH=./lib
node ./examples/simple/render.js ./examples/stylesheet.xml map.png


## Using node-mapnik from your node app

To require node-mapnik as a dependency of another package put in your package.json:

"dependencies" : { "mapnik":"*" } // replace * with a given semver version string


## Examples

See the 'examples/README.md' for more usage examples.

For some of the examples you will need:

npm install generic-pool
npm install get


## Tests

To run the tests do:

npm test

Or you can manually install mocha and then just do:

make test

## License

BSD, see LICENSE.txt
30 changes: 0 additions & 30 deletions examples/README.md

This file was deleted.

Binary file removed examples/data/world_merc.dbf
Binary file not shown.
Binary file removed examples/data/world_merc.index
Binary file not shown.
495 changes: 0 additions & 495 deletions examples/data/world_merc.json

This file was deleted.

1 change: 0 additions & 1 deletion examples/data/world_merc.prj

This file was deleted.

Binary file removed examples/data/world_merc.shp
Binary file not shown.
Binary file removed examples/data/world_merc.shx
Binary file not shown.
85 changes: 0 additions & 85 deletions examples/data/world_merc_license.txt

This file was deleted.

109 changes: 0 additions & 109 deletions examples/js_datasource/simple.js

This file was deleted.

0 comments on commit 9b78046

Please sign in to comment.