CalvinBackup/iD
1
0
Fork 0
mirror of https://github.com/FoggedLens/iD.git synced 2026-02-13 01:02:58 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update README install instructions and prerequisites

Browse Source
This commit is contained in:
Bryan Housel
2016-01-30 00:58:03 -05:00
parent 0d661b1061
commit 3f5d7ec701
3 changed files with 21 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
CONTRIBUTING.md
View File

@@ -153,13 +153,12 @@ feel free to use newer features wisely.
## Tests
Test your code and make sure it passes. Our testing harness requires [node.js](http://nodejs.org/)
and a few modules:
Test your code and make sure it passes.
1. [Install node.js](http://nodejs.org/) version 0.10.0 or later - 'Install' will download a package for your OS
2. Go to the directory where you have checked out `iD`
3. Run `npm install`
4. Run `npm test` to see whether your tests pass or fail.
1. Go to the directory where you have checked out `iD`
2. run `npm install`
3. run `make`
4. run `npm test` to see whether your tests pass or fail.
## Building / Installing

19
README.md
View File

@@ -17,14 +17,23 @@
* [Translate!](https://github.com/openstreetmap/iD/blob/master/CONTRIBUTING.md#translating)
[![translation chart](https://www.transifex.com/projects/p/id-editor/chart/image_png)](https://github.com/openstreetmap/iD/blob/master/CONTRIBUTING.md#translating)
## Prerequisites
* [Node.js](http://nodejs.org/) version 0.10.0 or newer
* Command line development tools (`make`, `git`, and a compiler) for your platform
* Ubuntu: `sudo apt-get install build-essential git`
* Mac OS X: Install Xcode and run `xcode-select --install` from a command line
## Installation
To run the current development version, fork this project, run `make`, and serve it locally.
If you have Python handy, just `cd` into the project root directory and run
To run the current development version of iD on your own computer:
python -m SimpleHTTPServer
Or, with a Mac, you can enable Web Sharing and clone iD into your website directory.
1. Create a local `git clone` of the project, then `cd` into the project folder
2. Run `npm install`
3. Run `make`
4. Start a local web server, e.g. `python -m SimpleHTTPServer`
5. Open `http://localhost:8000/` in a web browser
Come on in, the water's lovely. More help? Ping tmcw, jfire, or bhousel on IRC
(`irc.oftc.net`, in `#iD` or `#osm-dev` or `#osm`) or on the OSM mailing lists.

4
data/presets/README.md
View File

@@ -79,8 +79,8 @@ extension).
## Icons
Preset icons in iD are pulled from the open source POI icon set,
[Maki](http://www.mapbox.com/maki/). Icons are stored in `dist/img/maki-sprite.png`.
Preset icons in iD are pulled from the open source map icon set,
[Maki](http://www.mapbox.com/maki/).
The icons are identified in iD by the same name as they are on the Maki home. Use those
names when identifying the icon to be used for a given preset.