Files
iD/README.md
2012-12-04 18:34:09 -05:00

38 lines
1.6 KiB
Markdown

# iD - friendly JavaScript editor for [OpenStreetMap](http://www.openstreetmap.org/)
[![Build Status](https://secure.travis-ci.org/systemed/iD.png)](https://travis-ci.org/systemed/iD)
[![](https://raw.github.com/systemed/iD/master/screenshot.jpg)](http://geowiki.com/iD/)
[Try the online demo of the most recent code.](http://geowiki.com/iD/) and
[open issues for bugs and ideas!](https://github.com/systemed/iD/issues)
## Basics
* iD is a JavaScript [OpenStreetMap](http://www.openstreetmap.org/) 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](http://d3js.org/).
## Participate!
* [Read NOTES.md, our ongoing dev journal](https://github.com/systemed/iD/blob/master/NOTES.md)
* Fork this project. We eagerly accept pull requests.
* See [open issues in the issue tracker if you're looking for something to do](https://github.com/systemed/iD/issues?state=open)
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.
If you have Python handy, just `cd` into `iD` and run
python -m SimpleHTTPServer
Come on in, the water's lovely. More help? Ping RichardF, tmcw, or jfire on IRC
(`irc.oftc.net`, in `#osm-dev` or `#osm`), on the OSM mailing lists or at
richard@systemeD.net.
## License
iD is available under the [WTFPL](http://sam.zoy.org/wtfpl/), though obviously, if you want to dual-license
any contributions that's cool. It includes [d3js](http://d3js.org/), which BSD-licensed.