mirror of
https://github.com/FoggedLens/iD.git
synced 2026-02-25 23:13:42 +00:00
71 lines
3.5 KiB
Markdown
71 lines
3.5 KiB
Markdown
# iD - friendly JavaScript editor for [OpenStreetMap](http://www.openstreetmap.org/)
|
|
|
|
[](https://travis-ci.org/openstreetmap/iD)
|
|
|
|
## 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 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/).
|
|
|
|
## Participate!
|
|
|
|
* 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.
|
|
* [Translate!](https://github.com/openstreetmap/iD/blob/master/CONTRIBUTING.md#translating)
|
|
* 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
|
|
|
|
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).
|
|
|
|
## Prerequisites
|
|
|
|
* [Node.js](http://nodejs.org/) version 4 or newer
|
|
* Command line development tools (`make`, `git`, and a compiler) for your platform
|
|
* Ubuntu:
|
|
* `sudo apt-get install build-essential git`
|
|
* macOS:
|
|
* 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)
|
|
* Install [Cygwin](https://cygwin.com/install.html) - choose default packages + `make`, `wget`, `apache2` (needed for updated mime type list)
|
|
* Optionally, install [apt-cyg](https://github.com/transcode-open/apt-cyg) for managing your Cygwin packages
|
|
* 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>
|
|
|
|
## Installation
|
|
|
|
To run the current development version of iD on your own computer:
|
|
|
|
1. Create a local `git clone` of the project, then `cd` into the project folder
|
|
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
|
|
|
|
For guidance on building a packaged version, running tests, and contributing to
|
|
development, see [CONTRIBUTING.md](CONTRIBUTING.md).
|
|
|
|
## License
|
|
|
|
iD is available under the [ISC License](https://opensource.org/licenses/ISC).
|
|
It includes [d3.js](http://d3js.org/), which BSD-licensed.
|
|
|
|
## Thank you
|
|
|
|
Initial development of iD was made possible by a [grant of the Knight Foundation](http://www.mapbox.com/blog/knight-invests-openstreetmap/).
|