mirror of
https://github.com/FoggedLens/iD.git
synced 2026-05-18 14:45:12 +02:00
Merge pull request #3466 from openstreetmap/tyrasd-update-installreadme
Update installation instructions and prerequisites
This commit is contained in:
+1
-13
@@ -177,23 +177,11 @@ you can install this via homebrew with `brew install phantomjs`. Then:
|
||||
|
||||
## Building / Installing
|
||||
|
||||
You can build a concatenated and minified version of iD with the command `make`. Node.js is
|
||||
required for this.
|
||||
You can build a concatenated and minified version of iD with the command `make && npm run build-min`.
|
||||
|
||||
iD will be built to the `dist` directory. This directory is self-contained; you can copy it
|
||||
into the public directory of your webserver to deploy iD.
|
||||
|
||||
## Live reloading
|
||||
|
||||
You can use [live-server](https://www.npmjs.com/package/live-server) *(npm module)* to
|
||||
reload the browser automatically whenever there is a change in code.
|
||||
|
||||
1. run `npm install -g live-server`
|
||||
2. run `live-server .` or `live-server dist`
|
||||
*(You will be automatically redirected to the local server page.)*
|
||||
|
||||
*(Note: Sometimes auto reload might not display correctly and you might need to rebuild iD by running `make`.)*
|
||||
|
||||
## Licensing
|
||||
|
||||
iD is available under the [ISC License](https://opensource.org/licenses/ISC).
|
||||
|
||||
@@ -54,7 +54,7 @@ To run the current development version of iD on your own computer:
|
||||
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 the local web server `npm run-script web`
|
||||
5. Run `npm start`
|
||||
6. Open `http://localhost:8080/` in a web browser
|
||||
|
||||
For guidance on building a packaged version, running tests, and contributing to
|
||||
|
||||
Reference in New Issue
Block a user