|
1 |
| -Maintenance status: |
| 1 | +# General Info |
2 | 2 |
|
3 |
| -TileMill has shifted to an [open open source](http://openopensource.org/) contributor model and moved to its own organization, `tilemill-project`. |
| 3 | +TileOven is a maintained fork of TileMill, tested on Linux with Node 8.11.3 LTS |
| 4 | +TileOven works only in server mode, no native packages are provided. |
| 5 | +Platforms other than Linux should theoretically work, but aren't tested. |
4 | 6 |
|
5 |
| -## Alternatives to TileMill |
| 7 | +Changes from upstream are cherry-picked, last time on Apr 22, 2016. |
6 | 8 |
|
7 |
| -**Mapbox** |
8 | 9 |
|
9 |
| -* [Mapbox Studio](https://www.mapbox.com/mapbox-studio/): the official, supported successor to TileMill |
| 10 | +# Changelog since forking |
10 | 11 |
|
11 |
| -**Community** |
| 12 | +## Features |
12 | 13 |
|
13 |
| -* [Kosmtik](https://github.com/kosmtik/kosmtik): alternative to TileMill |
14 |
| -* [TileOven](https://github.com/florianf/tileoven): fork of TileMill with Node 4 support |
| 14 | +- Forked millstone, tilelive, node-srs dependencies, Node 8 now supported |
| 15 | +- Support for Node 8, thanks to patches and updated dependencies of @paulovieira |
| 16 | +- Added layer selection to map panel for fast comparisons with OSM and to save render time for low zoom levels |
| 17 | +- Added search field to layer panel |
| 18 | +- Added search field to styles panel |
| 19 | +- Added cloning of layers to layer panel |
| 20 | +- Layer actions only shown on hover, ideal for long layer names and reduces visual noise |
| 21 | +- Increased size of layer panel |
| 22 | +- Updated carto and node-mapnik dependencies, new CartoCSS commands available |
| 23 | +- Remember last selected folder in new layer dialog |
| 24 | +- Better compatibility with kosmtik, TileOven mml project files should work out of the box with kosmtik (https://github.com/kosmtik) |
15 | 25 |
|
16 |
| -## Installation |
| 26 | +## Bugfixes |
17 | 27 |
|
18 |
| -To install from source just do: |
| 28 | +- Removed topcube and other obsolete dependencies |
| 29 | +- Removed windowed mode, only server mode is supported |
| 30 | +- Fixed Tab indentation in editor window |
| 31 | +- Fixed "Close" button bugs in Google Chrome (https://github.com/mapbox/tilemill/issues/2534) |
| 32 | +- Fixed mbtiles preview map |
| 33 | +- Removed Mapbox integration |
| 34 | +- Fixed CartoCSS variable auto completion |
| 35 | +- Fixed creation of job file in export if it doesn't exist |
| 36 | +- Fixed multiple output of CartoCSS errors to update to latest version |
19 | 37 |
|
20 |
| - git clone https://github.com/tilemill-project/tilemill.git |
21 |
| - cd tilemill |
22 |
| - npm install |
| 38 | +# Readme |
23 | 39 |
|
24 |
| -Then to start TileMill do: |
| 40 | +TileOven is a modern map design studio powered by [Node.js](http://nodejs.org) and [Mapnik](http://mapnik.org). |
| 41 | + |
| 42 | +Installation instructions, development docs and other information are available in the [Wiki](https://github.com/florianf/tileoven/wiki/Installation-Guide). |
| 43 | + |
| 44 | +# Build Status |
| 45 | + |
| 46 | +[](https://travis-ci.org/florianf/tileoven) |
| 47 | +[](https://david-dm.org/florianf/tileoven) |
| 48 | + |
| 49 | +### Key modules |
| 50 | + |
| 51 | +- mapnik - [](https://travis-ci.org/mapnik/mapnik) |
| 52 | +- node-mapnik - [](https://travis-ci.org/mapnik/node-mapnik) |
| 53 | +- carto - [](http://travis-ci.org/mapbox/carto) |
| 54 | +- tilelive - [](https://travis-ci.org/mapbox/tilelive) |
| 55 | +- tilelive-mapnik - [](https://travis-ci.org/mapbox/tilelive-mapnik) |
| 56 | +- millstone - [](http://travis-ci.org/mapbox/millstone) |
| 57 | +- node-mbtiles - [](http://travis-ci.org/mapbox/node-mbtiles) |
| 58 | +- node-sqlite3 - [](http://travis-ci.org/mapbox/node-sqlite3) |
| 59 | + |
| 60 | +# Depends |
| 61 | + |
| 62 | +- Mapnik v2.3.0 |
| 63 | +- Node.js v6.x, v4.x, v0.10.x or v0.8.x |
| 64 | +- Protobuf: libprotobuf-lite and protoc |
| 65 | + |
| 66 | +However, node-mapnik (which depends on Mapnik and protobuf) is now packaged as a binary. So, you do not need an external Mapnik. See [Installation](#installation) |
25 | 67 |
|
26 |
| -As a Desktop application: |
| 68 | +# Installation |
27 | 69 |
|
28 |
| - ./index.js |
| 70 | +Note: on Ubuntu make sure that you have the nodejs-legacy package installed! |
29 | 71 |
|
30 |
| -To run the **web version** pass `server=true`: |
31 |
| - |
32 |
| - ./index.js --server=true |
| 72 | +To install from source just do: |
| 73 | + |
| 74 | + git clone https://github.com/florianf/tileoven.git |
| 75 | + cd tileoven |
| 76 | + npm install |
33 | 77 |
|
34 |
| -and then go to `localhost:20009` in your web browser |
| 78 | +Then to start TileMill do: |
35 | 79 |
|
| 80 | + ./index.js # and then view http://localhost:20009 in your web browser |
36 | 81 |
|
37 | 82 | For more extended details follow:
|
38 | 83 |
|
39 | 84 | - [Install packages](http://mapbox.com/tilemill/docs/install/)
|
40 | 85 | - [Build from source](http://mapbox.com/tilemill/docs/source/)
|
| 86 | + |
| 87 | +# Running tests |
| 88 | + |
| 89 | +Install mocha and run the tests |
| 90 | + |
| 91 | + npm install mocha |
| 92 | + npm test |
| 93 | + |
| 94 | + |
| 95 | +Note: the tests require a running postgres server and a postgis enabled |
| 96 | +database called `template_postgis`. |
| 97 | + |
| 98 | +If you do not have a `template_postgis` create one like: |
| 99 | + |
| 100 | + createdb -E UTF8 template_postgis |
| 101 | + psql -c "CREATE EXTENSION postgis" template_postgis |
| 102 | + |
| 103 | +If you experience failing tests here are two tips: |
| 104 | + |
| 105 | +1. Debug the project data by running TileMill with |
| 106 | + |
| 107 | + ./index.js --files=./test/fixtures/files/ |
| 108 | + |
| 109 | +2. Try clearing the cache of test data: |
| 110 | + |
| 111 | + rm -rf ./test/fixtures/files/ |
| 112 | + |
| 113 | +For more info see: http://postgis.net/docs/manual-1.5/ch02.html |
| 114 | + |
| 115 | + |
| 116 | +# Documentation |
| 117 | + |
| 118 | +TileMill documentation is kept in the mb-pages branch, which is independently managed and not merged with master. |
| 119 | + |
| 120 | +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 |
| 121 | +sync'ed from the mb-pages branch. |
| 122 | + |
| 123 | +To view all the TileMill documentation locally, first checkout the mb-pages branch: |
| 124 | + |
| 125 | + git checkout mb-pages |
| 126 | + |
| 127 | +Then install Jekyll: |
| 128 | + |
| 129 | + sudo gem install jekyll |
| 130 | + |
| 131 | +And run Jekyll: |
| 132 | + |
| 133 | + jekyll |
| 134 | + |
| 135 | +Once Jekyll has started you should be able to view the docs in a browser at: |
| 136 | + |
| 137 | + http://localhost:4000/tilemill/ |
| 138 | + |
| 139 | + |
| 140 | +# Syncing manual |
| 141 | + |
| 142 | +To sync the manual with mb-pages updates do: |
| 143 | + |
| 144 | + export TILEMILL_SOURCES=`pwd` |
| 145 | + cd ../ |
| 146 | + git clone --depth=1 -b mb-pages https://github.com/mapbox/tilemill tilemill-mb-pages |
| 147 | + cd ${TILEMILL_SOURCES} |
| 148 | + export TILEMILL_GHPAGES=../tilemill-mb-pages |
| 149 | + rm -rf ${TILEMILL_SOURCES}/assets/manual |
| 150 | + mkdir -p ${TILEMILL_SOURCES}/assets/manual |
| 151 | + cp -r ${TILEMILL_GHPAGES}/assets/manual/* ${TILEMILL_SOURCES}/assets/manual/ |
| 152 | + git add ${TILEMILL_SOURCES}/assets/manual/* |
| 153 | + rm -rf ${TILEMILL_SOURCES}/_posts/docs/reference |
| 154 | + mkdir -p ${TILEMILL_SOURCES}/_posts/docs/reference |
| 155 | + cp -r ${TILEMILL_GHPAGES}/_posts/docs/reference/* ${TILEMILL_SOURCES}/_posts/docs/reference/ |
| 156 | + git add ${TILEMILL_SOURCES}/_posts/docs/reference/* |
0 commit comments