Navigation Menu

Skip to content

Commit

Permalink
Update READMe.
Browse files Browse the repository at this point in the history
  • Loading branch information
Young Hahn committed Feb 28, 2011
1 parent 08c8a20 commit 529c226
Showing 1 changed file with 53 additions and 7 deletions.
60 changes: 53 additions & 7 deletions README.md
@@ -1,20 +1,27 @@
TileStream
----------
A high performance tile server for [MBTiles][1] files.
A high performance tile server and simple web viewer for [MBTiles][1] files.

[1]:[http://mbtiles.org]


Features
--------
- MBTiles-based tile server
- Minimal gallery view and OpenLayers based viewer of tiles
- Support for MBTiles interaction using [Wax](http://github.com/mapbox/wax)


Requirements
------------
- Tested: Mac OS X 10.6, Ubuntu 10.10
- At least 2GB memory
- May work: Older versions, other POSIX-compliant systems
- The [prerequisites for node][2] (python, libssl-dev)
- *TileStream client*
- Tested: Chrome 6+, Firefox 3+, IE8+
- May work: Opera 11
- *TileStream server*
- Tested: Mac OS X 10.6, Ubuntu 10.10
- At least 613MB memory
- May work: Older versions, other POSIX-compliant systems
- The [prerequisites for node][2] (python, libssl-dev)

[2]:https://github.com/ry/node/wiki/Installation

Expand All @@ -23,9 +30,9 @@ Installation: Mac OS X 10.6
---------------------------
Install [Xcode][3] for Mac OS X.

Install TileStream:
Download and unpack TileStream. Build & install:

cd TileStream
cd tilestream
./ndistro

Start TileStream:
Expand All @@ -36,3 +43,42 @@ TileStream should now be accessible from a browser at `http://localhost:9000`.

[3]:http://developer.apple.com/technologies/tools/xcode.html


Installation: Ubuntu 10.10
--------------------------
Install build requirements:

sudo apt-get install build-essential libssl-dev libsqlite3-0 libsqlite3-dev

Download and unpack TileStream. Build & install:

cd tilesteram
./ndistro

Start TileStream:

./tilestream

TileStream should now be accessible from a browser at `http://localhost:9000`.


Configuration
-------------
Optional. Edit `settings.js` to change server settings including port, tiles
directory, and default baselayer.


Usage
-----
MBTiles files should be placed in the `tilestream/tiles` directory. Each
tileset can be previewed at `http://localhost:9000/tileset/[filename]` where
`[filename]` is the name of the tileset file without the `.mbtiles` extension.


Contributors
------------
- [Young Hahn](http://github.com/yhahn)
- [Tom MacWright](http://github.com/tmcw)
- [Will White](http://github.com/willwhite)
- [Konstantin Käfer](http://github.com/kkaefer)
- [Dane Springmeyer](http://github.com/springmeyer)

0 comments on commit 529c226

Please sign in to comment.