Skip to content

Latest commit

 

History

History
55 lines (35 loc) · 2.5 KB

CONTRIBUTING.md

File metadata and controls

55 lines (35 loc) · 2.5 KB
Raw

Build Status

Key modules

Build Status Build status Dependencies

  • mapnik - Build Status
  • node-mapnik - Build Status
  • carto - Build Status
  • tilelive - TBD
  • tilelive-mapnik - Build Status
  • millstone - TBD
  • node-mbtiles - Build Status
  • node-sqlite3 - Build Status

Running tests

Install mocha and run the tests

npm install mocha
npm test

Note: the tests require a running postgres server and a postgis enabled database called template_postgis.

If you do not have a template_postgis create one like:

createdb -E UTF8 template_postgis
psql -c "CREATE EXTENSION postgis" template_postgis

For more detailed info, see the Using Open Street Map (OSM) Data in TileMill section of the installation guide. For more info see: http://postgis.net/docs/manual-1.5/ch02.html

  1. Debug the project data by running TileMill with

    ./index.js --files=./test/fixtures/files/

  2. Try clearing the cache of test data:

    rm -rf ./test/fixtures/files/

Documentation

TileMill documentation is kept in the gh-pages branch, which is independently managed and not merged with master.

TileMill's in-app reference available as the "Manual" (see below for syncing details) is a very small subset of docs for offline usage and is manually sync'ed from the gh-pages branch.

To checkout the g-pages branch, do the following:

cd ~
git clone -b gh-pages https://github.com/tilemill-project/tilemill.git tilemill-gh-pages

You can find more info about how to keep the documentation up to date in the CONTRIBUTING.md file within the tilemill-gh-pages directory.