Skip to content

Commit

Permalink
renamed README to use Markup and formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
nvkelso committed May 14, 2012
1 parent ca7a655 commit c486fcb
Showing 1 changed file with 25 additions and 25 deletions.
50 changes: 25 additions & 25 deletions README → README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
TileStache: a stylish alternative for caching your map tiles.
#TileStache:
_a stylish alternative for caching your map tiles_

TileStache is a Python-based server application that can serve up map tiles
based on rendered geographic data. You might be familiar with TileCache
(http://tilecache.org), the venerable open source WMS server from MetaCarta.
TileStache is similar, but we hope simpler and better-suited to the needs of
designers and cartographers.
**TileStache** is a Python-based server application that can serve up map tiles
based on rendered geographic data. You might be familiar with [TileCache](http://tilecache.org),
the venerable open source WMS server from MetaCarta. TileStache is similar, but we hope
simpler and better-suited to the needs of designers and cartographers.

---- Synopsis ----
##Synopsis

import TileStache
import ModestMaps
Expand All @@ -30,14 +30,14 @@ designers and cartographers.



---- Dependencies ----
##Dependencies

Required:
###Required:

- ModestMaps: http://modestmaps.com, http://github.com/migurski/modestmaps-py
- Python Imaging Library (PIL): http://www.pythonware.com/products/pil

Optional:
###Optional:

- Simplejson: https://github.com/simplejson/simplejson (optional if using >= python 2.6)
- mapnik: http://mapnik.org (optional)
Expand All @@ -57,7 +57,7 @@ Install Mapnik via instructions at:
http://mapnik.org/download


---- Installation ----
##Installation

TileStache can be run from the download directory as is. For example the scripts:

Expand All @@ -75,7 +75,7 @@ To install globally do:
to fully install TileStache.


---- Quickstart ----
##Quickstart

To make sure TileStache is working start the development server:

Expand All @@ -89,29 +89,29 @@ This is a previewer that uses ModestMaps and OpenStreetMap tiles from
http://tile.osm.org as defined in the default config file 'tilestache.cfg'


---- Documentation ----
##Documentation

The next step is to learn how build custom layers and serve them.

See http://tilestache.org/doc/ for details.
See the [docs](http://tilestache.org/doc/) for details.


---- Features ----
##Features

Rendering providers:
- Mapnik
- Proxy
- Vector
- Templated URLs
* Mapnik
* Proxy
* Vector
* Templated URLs

Caching backends:
- Local disk
- Test
- Memcache
- S3
* Local disk
* Test
* Memcache
* S3


---- Design Goals ----
##Design Goals

The design of TileStache focuses on approachability at the expense of
cleverness or completeness. Our hope is to make it easy for anyone to design
Expand Down Expand Up @@ -144,6 +144,6 @@ necessary to support any external system, but we eschew complex, impenetrable
standards in favor of pragmatic, fast utility with basic web clients.


---- License ----
##License

BSD, see LICENSE file.

0 comments on commit c486fcb

Please sign in to comment.