Commit 801fe10a authored by Adrien Pavie's avatar Adrien Pavie
Browse files

Documentation update

parent a2ccfba1
......@@ -3,12 +3,14 @@ can support plugin development.
## URL parameters
iD supports several URL parameters. When constructing a URL to a standalone instance
iD-indoor supports several URL parameters. When constructing a URL to a standalone instance
of iD (e.g. `http://openstreetmap.us/iD/release/`), the following parameters are available
in the hash portion of the URL:
* `map` - A slash separated zoom level, longitude, and latitude. Example:
`map=20.00/-77.02271/38.90085`.
* `level` - A decimal level value, indicating which floor must be shown when map loads.
Example: `level=3` or `level=-2.5`
* `id` - The character 'n', 'w', or 'r', followed by the OSM ID of a node,
way or relation, respectively. Selects the specified entity, and, unless
a `map` parameter is also provided, centers the map on it.
......
# Contributing to iD
# Contributing to iD-indoor
iD-indoor is a fork from original iD editor. If you want to contribute to the simple indoor editor, you can report issues in this repository.
The following concerns the main iD editor, you can follow this for contributing to the core functionnalities of iD.
-------------------------------------------------------------------------------------------------------------------------------------------------
Thinking of contributing to iD? High five! Here are some basics for our habits
so that you can write code that fits in perfectly.
......
## What is iD-indoor ?
iD-indoor is a fork from original iD editor, augmented with [indoor mapping](http://wiki.openstreetmap.org/wiki/Indoor_Mapping) functionnalities.
## What is different between iD and iD-indoor
In the end, only a few things, but things that matters when doing indoor mapping:
* A level selector allows to filter which floor should be shown on map
* The tag presets contains indoor-related features (rooms, doors, corridors...) and small objects (fire extinguishers, public transport ticket validators, shop shelfs...)
* Dedicated map style for the previous objects
* And other functionnalities that makes editing easier.
## How is "iD" pronounced?
Two syllables: "eye dee".
......
# iD - friendly JavaScript editor for [OpenStreetMap](http://www.openstreetmap.org/) - Indoor edition
[![Build Status](https://secure.travis-ci.org/openstreetmap/iD.png)](https://travis-ci.org/openstreetmap/iD)
# iD-indoor - friendly JavaScript indoor editor for [OpenStreetMap](http://www.openstreetmap.org/)
## Basics
* iD is a JavaScript [OpenStreetMap](http://www.openstreetmap.org/) editor.
* iD-indoor is a JavaScript [OpenStreetMap](http://www.openstreetmap.org/) editor.
* It's based on [iD, the simple OpenStreetMap editor](http://ideditor.com/).
* It's intentionally simple. It lets you do the most basic tasks while
not breaking other people's data.
* It's focused on [indoor mapping](http://wiki.openstreetmap.org/wiki/Indoor_Mapping), making contributions easier.
* It supports modern browsers. Data is rendered with [d3.js](http://d3js.org/).
## Participate!
## Live instance
* 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
* See [it working in live here](http://github.pavie.info/id-indoor).
## Participate!
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).
* 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).
## Prerequisites
......@@ -32,7 +27,7 @@ Come on in, the water's lovely. More help? Ping `jfire` or `bhousel` on
## Installation
To run the current development version of iD on your own computer:
To run the current development version of iD-indoor on your own computer:
1. Create a local `git clone` of the project, then `cd` into the project folder
2. Run `npm install`
......@@ -45,9 +40,11 @@ development, see [CONTRIBUTING.md](CONTRIBUTING.md).
## License
iD-indoor is based on iD, so available under the same 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/).
\ No newline at end of file
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/).
List of features to implement in the future.
## Soon
### Presets
* public_transport=waiting_area
### Styles
* Vertical passages (stairs, elevators, conveying stairs)
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment