Browse files

Simplify, boldify

  • Loading branch information...
1 parent 22fe357 commit ce4c6c4fec0efca1727e2c8141ae73829a4a6509 @tmcw tmcw committed Dec 4, 2012
Showing with 12 additions and 53 deletions.
  1. +12 −53
@@ -1,34 +1,24 @@
-# iD - friendly JavaScript editor for OpenStreetMap
+# iD - friendly JavaScript editor for [OpenStreetMap](
+[![Build Status](](
-[Try the online demo of the most recent code.](
+[Try the online demo of the most recent code.]( and
+[open issues for bugs and ideas!](
## Basics
-* iD is a JavaScript-based [OpenStreetMap]( editor.
-* It's intentionally simple. This is not a 90% editor -
- not even a 70% editor. It should let you do the most basic tasks while
- not breaking other people's data. Nothing more. (Same goes for the code,
- so go easy on the abstraction. :) )
-* We're aiming to support modern desktop browsers and mobile browsers. The map
- rendering uses [SVG]( via
- [d3](
-## Architecture
+* iD is a JavaScript [OpenStreetMap]( editor.
+* It's intentionally simple. It lets you do the most basic tasks while
+ not breaking other people's data.
+* We support modern browsers. Data is rendered with [d3](
-* iD uses [d3]( for graphics & managing databindings to the
- map. There's a tiny tiled-map core, but the majority of the action is in
- dynamic rendering of the editable map data.
-* This project aims to create a usable object model of [OpenStreetMap data](
- in Javascript that can be transformed by actions and serialized back into
- [changesets](
-## Getting started
+## Participate!
+* [Read, our ongoing dev journal](
* Fork this project. We eagerly accept pull requests.
* See [open issues in the issue tracker if you're looking for something to do](
-* All the code is in js/iD.
To run the code locally, just fork this project and run it from a local webserver.
With a Mac, you can enable Web Sharing and drop this in your website directory.
@@ -37,38 +27,7 @@ If you have Python handy, just `cd` into `iD` and run
python -m SimpleHTTPServer
-## How it works
-The code inherits many elements from the [Potlatch 2](
-and [JOSM]( editors.
-We store technical notes in []( The
-basic architecture is as follows:
-* Map: vector rendering, panning behaviors & zoom/center state
-* Tiles: receives map centers & draw tiles as a background for iD
-* Connection: requests `/map` data from osm, parses this data and delivers it to the Graph
-* Graph: stores a javascript object of `id -> osm object`
-* History: stores multiple graphs which represent undo states
-* Map has-a Tiles
-* Map has-a Connection
-* Map has-a History
-* History has-many Graphs
-## Coding tips
-This project has a few basic guidelines for incoming code. The cardinal rules are:
-1. Soft tabs only
-2. Everything should pass [jshint]( without warning
-3. Never write bugs
-(you can write bugs). If you need a style guide, [AirBNB has a decent one.](
-Come on in, the water's lovely. More help? Ping RichardF or tmcw on IRC
+Come on in, the water's lovely. More help? Ping RichardF, tmcw, or jfire on IRC
(``, in `#osm-dev` or `#osm`), on the OSM mailing lists or at

0 comments on commit ce4c6c4

Please sign in to comment.