README.md 3.33 KB
Newer Older
Adrien Pavie's avatar
Adrien Pavie committed
1
2
3
# __iD-indoor is not actively maintained. For a brand-new indoor editor, please check-out [OsmInEdit](https://framagit.org/PanierAvide/osminedit)__

iD-indoor - friendly JavaScript indoor editor for [OpenStreetMap](http://www.openstreetmap.org/)
Richard Fairhurst's avatar
Richard Fairhurst committed
4

Tom MacWright's avatar
Tom MacWright committed
5
6
## Basics

Adrien Pavie's avatar
Adrien Pavie committed
7
8
* iD-indoor is a JavaScript [OpenStreetMap](http://www.openstreetmap.org/) editor.
* It's based on [iD, the simple OpenStreetMap editor](http://ideditor.com/).
Tom MacWright's avatar
Tom MacWright committed
9
10
* It's intentionally simple. It lets you do the most basic tasks while
  not breaking other people's data.
Adrien Pavie's avatar
Adrien Pavie committed
11
* It's focused on [indoor mapping](http://wiki.openstreetmap.org/wiki/Indoor_Mapping), making contributions easier.
12
13
14
15
* 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/).
16

Adrien Pavie's avatar
Adrien Pavie committed
17
## Live instance
Tom MacWright's avatar
Tom MacWright committed
18

Adrien Pavie's avatar
Adrien Pavie committed
19
20
21
* See [it working in live here](http://github.pavie.info/id-indoor).

## Participate!
Tom MacWright's avatar
Tom MacWright committed
22

Adrien Pavie's avatar
Adrien Pavie committed
23
24
* You can report bugs or missing features in [the issue tracker](https://git.framasoft.org/PanierAvide/iD-indoor/issues).
* If you see a bug not related to indoor features, you can report it in the [iD issue tracker](https://github.com/openstreetmap/iD/issues).
25

26
## Prerequisites
Tom MacWright's avatar
Tom MacWright committed
27
28

* [Node.js](http://nodejs.org/) version 4 or newer
29
* Command line development tools (`make`, `git`, and a compiler) for your platform
30
31
  * Ubuntu:
    * `sudo apt-get install build-essential git`
Bryan Housel's avatar
Bryan Housel committed
32
  * macOS:
33
34
35
    * 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)
36
    * Install [Cygwin](https://cygwin.com/install.html) - choose default packages + `make`, `wget`, `apache2` (needed for updated mime type list)
37
    * Optionally, install [apt-cyg](https://github.com/transcode-open/apt-cyg) for managing your Cygwin packages
38
39
40
41
42
43
44
    * 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>
45
46

## Installation
Tom MacWright's avatar
Tom MacWright committed
47

Adrien Pavie's avatar
Adrien Pavie committed
48
To run the current development version of iD-indoor on your own computer:
Richard Fairhurst's avatar
Richard Fairhurst committed
49

50
1. Create a local `git clone` of the project, then `cd` into the project folder
51
52
53
54
55
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
56

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

Tom MacWright's avatar
Tom MacWright committed
60
61
## License

Adrien Pavie's avatar
Adrien Pavie committed
62
iD-indoor is based on iD, so available under the same license.
Bryan Housel's avatar
Bryan Housel committed
63
iD is available under the [ISC License](https://opensource.org/licenses/ISC).
64
It includes [d3.js](http://d3js.org/), which BSD-licensed.
Alex Barth's avatar
Alex Barth committed
65
66
67

## Thank you

Adrien Pavie's avatar
Adrien Pavie committed
68
69
iD-indoor couldn't exist without the great work of the iD editor team.
Initial development of iD was made possible by a [grant of the Knight Foundation](http://www.mapbox.com/blog/knight-invests-openstreetmap/).