Files
iD/README.md
2013-03-15 19:58:13 -03:00

42 lines
1.8 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)
[![](http://ideditor.com/img/editor.png)](http://ideditor.com/)
## 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.
* It supports modern browsers. Data is rendered with [d3](http://d3js.org/).
## Participate!
* [Try out the latest stable release](http://openstreetmap.us/iD/release)
* [Read up on Contributing and the code style of iD](CONTRIBUTING.md)
* See [open issues in the issue tracker](https://github.com/systemed/iD/issues?state=open) if you're looking for something to do
* [Translate!](https://github.com/systemed/iD/blob/master/CONTRIBUTING.md#translating)
[![translation chart](https://www.transifex.com/projects/p/id-editor/chart/image_png)](https://github.com/systemed/iD/blob/master/CONTRIBUTING.md#translating)
## Installation
To run the current development version, fork this project and serve it locally.
If you have Python handy, just `cd` into the project root directory and run
python -m SimpleHTTPServer
Or, with a Mac, you can enable Web Sharing and clone iD into your website directory.
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.
For guidance on building a packaged version, running tests, and contributing to
development, see [CONTRIBUTING.md](CONTRIBUTING.md).
## 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.