Permalink
Browse files

touchup readme

  • Loading branch information...
1 parent 3322d6d commit c2c3e797dba31e03eec07c15392a460ba3bfa070 @springmeyer springmeyer committed Jul 4, 2012
Showing with 12 additions and 17 deletions.
  1. +10 −15 README.md
  2. +1 −1 examples/README.md
  3. +1 −1 package.json
View
25 README.md
@@ -59,11 +59,7 @@ Mapnik 2.1.0 is targeted, but 2.0.x is also supported. This means that if you ar
## Installation
-First install Mapnik master from github:
-
- git clone https://github.com/mapnik/mapnik.git
-
-For more details see: https://github.com/mapnik/mapnik/wiki/Mapnik-Installation
+First install Mapnik - for more details see: https://github.com/mapnik/mapnik/wiki/Mapnik-Installation
Confirm that the `mapnik-config` program is available and on your $PATH.
@@ -95,36 +91,35 @@ 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
- ./examples/simple/render.js ./examples/stylesheet.xml map.png
+ node ./examples/simple/render.js ./examples/stylesheet.xml map.png
## Using node-mapnik from your node app
-To require node-mapnik as a depedency of another package put in your package.json:
+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/' folder for more usage examples.
+See the 'examples/README.md' for more usage examples.
-For some of the tests you will need:
+For some of the examples you will need:
npm install generic-pool
npm install get
## Tests
-To run the tests first install mocha:
-
- npm install mocha
-
-Then run:
+To run the tests do:
- make test
+ npm test
+
+Or you can manually install mocha and then just do:
+ make test
## License
View
2 examples/README.md
@@ -2,7 +2,7 @@
Examples are designed to be run from the root like:
- ./examples/simple/render.js examples/stylesheet.xml map.png
+ node ./examples/simple/render.js examples/stylesheet.xml map.png
## Depends
View
2 package.json
@@ -47,7 +47,7 @@
},
"scripts" : {
"install" : "node-waf -v configure build",
- "pretest" : "npm install --dev",
+ "pretest" : "npm install mocha",
"test" : "make test"
}
}

0 comments on commit c2c3e79

Please sign in to comment.