README.md 3.46 KB
Newer Older
Tom MacWright's avatar
Tom MacWright committed
1 2
# iD - friendly JavaScript editor for [OpenStreetMap](http://www.openstreetmap.org/)

3
[![Build Status](https://travis-ci.org/openstreetmap/iD.svg?branch=master)](https://travis-ci.org/openstreetmap/iD)
4

5 6
## Basics

Tom MacWright's avatar
Tom MacWright committed
7 8 9
* 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.
10 11 12 13
* It supports all popular modern desktop browsers: Chrome, Firefox, Safari,
  Opera, Edge, and IE11.
* iD is not yet designed for mobile browsers, but this is something we hope to add!
* Data is rendered with [d3.js](http://d3js.org/).
14

Tom MacWright's avatar
Tom MacWright committed
15
## Participate!
16

17 18 19
* Read the project [Code of Conduct](CODE_OF_CONDUCT.md) and remember to be nice to one another.
* Read up on [Contributing and the code style of iD](CONTRIBUTING.md).
* See [open issues in the issue tracker](https://github.com/openstreetmap/iD/issues?state=open) if you're looking for something to do.
John Firebaugh's avatar
John Firebaugh committed
20
* [Translate!](https://github.com/openstreetmap/iD/blob/master/CONTRIBUTING.md#translating)
21 22 23
* Test a prerelease version of iD:
  * Stable mirror of `release` branch:  http://openstreetmap.us/iD/release
  * Development mirror of `master` branch:  http://openstreetmap.us/iD/master
24

25 26 27
Come on in, the water's lovely. More help? Ping `jfire` or `bhousel` on
[OpenStreetMap IRC](http://wiki.openstreetmap.org/wiki/IRC)
(`irc.oftc.net`, in `#iD` or `#osm-dev` or `#osm`) or on the [OpenStreetMap `dev` mailing list](http://wiki.openstreetmap.org/wiki/Mailing_lists).
28

29
## Prerequisites
Tom MacWright's avatar
Tom MacWright committed
30 31

* [Node.js](http://nodejs.org/) version 4 or newer
32
* Command line development tools (`make`, `git`, and a compiler) for your platform
33 34
  * Ubuntu:
    * `sudo apt-get install build-essential git`
Bryan Housel's avatar
Bryan Housel committed
35
  * macOS:
36 37 38
    * Install [Xcode](https://developer.apple.com/xcode/) and run `xcode-select --install` from a command line
  * Windows (Cygwin):
    * Install [Git for Windows](https://git-scm.com/downloads)
39
    * Install [Cygwin](https://cygwin.com/install.html) - choose default packages + `make`, `wget`, `apache2` (needed for updated mime type list)
40
    * Optionally, install [apt-cyg](https://github.com/transcode-open/apt-cyg) for managing your Cygwin packages
41 42 43 44 45 46 47
    * Edit `~/.bashrc`:<br/>
      Put Git for Windows before Cygwin in PATH, otherwise `npm install` may [fail to fetch git repositories](https://github.com/npm/npm/issues/7456)<br/><pre>
      export PATH=/cygdrive/c/Program\ Files/Git/mingw64/bin/:$PATH</pre>
    * Edit `~/.gitconfig`:<br/>
      Add these lines to avoid checking in files with CRLF newlines<br><pre>
      [core]
          autocrlf = input</pre>
48 49

## Installation
50

51
To run the current development version of iD on your own computer:
52

53
1. Create a local `git clone` of the project, then `cd` into the project folder
54 55 56 57 58
2. (Windows Only)  Run `fixWinSymlinks.bat`.  This script will prompt for Administrator rights.  see also: http://stackoverflow.com/questions/5917249/git-symlinks-in-windows
3. Run `npm install`
4. Run `make`
5. Start a local web server, e.g. `python -m SimpleHTTPServer`
6. Open `http://localhost:8000/` in a web browser
John Firebaugh's avatar
John Firebaugh committed
59

John Firebaugh's avatar
John Firebaugh committed
60 61 62
For guidance on building a packaged version, running tests, and contributing to
development, see [CONTRIBUTING.md](CONTRIBUTING.md).

63 64
## License

Bryan Housel's avatar
Bryan Housel committed
65
iD is available under the [ISC License](https://opensource.org/licenses/ISC).
66
It includes [d3.js](http://d3js.org/), which BSD-licensed.
Alex Barth's avatar
Alex Barth committed
67 68 69

## Thank you

Alex Barth's avatar
Alex Barth committed
70
Initial development of iD was made possible by a [grant of the Knight Foundation](http://www.mapbox.com/blog/knight-invests-openstreetmap/).