diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f6bdc091b..19f1d9b06 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -370,10 +370,7 @@ Note that in order to run the tests, Chrome needs to be installed on the system. ### Building / Installing -You can rebuild iD completely with the command `npm run all`. - -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. +Follow the steps in the [how to get started guide](https://github.com/openstreetmap/iD/wiki/How-to-get-started#build-and-test-instructions) on how to build and run iD. ### Licensing diff --git a/README.md b/README.md index 507adb831..f995f3ea7 100644 --- a/README.md +++ b/README.md @@ -27,47 +27,9 @@ Come on in, the water's lovely. More help? Ping `Martin Raifer`/`tyr_asd` or `bh * [OpenStreetMap IRC](https://wiki.openstreetmap.org/wiki/IRC) (`irc.oftc.net`, in `#osm-dev`) * [OpenStreetMap `dev` mailing list](https://wiki.openstreetmap.org/wiki/Mailing_lists) -## Prerequisites - -* [Node.js](https://nodejs.org/) version 18 or newer -* [`git`](https://www.atlassian.com/git/tutorials/install-git/) for your platform - * Note for Windows users: - * Edit `$HOME\.gitconfig`:
- Add these lines to avoid checking in files with CRLF newlines
-      [core]
-          autocrlf = input
- ## Installation -To run the current development version of iD on your own computer: - -#### Cloning the repository - -The repository is reasonably large, and it's unlikely that you need the full history (~200 MB). If you are happy to wait for it all to download, run: - -``` -git clone https://github.com/openstreetmap/iD.git -``` - -To clone only the most recent version, instead use a 'shallow clone': - -``` -git clone --depth=1 https://github.com/openstreetmap/iD.git -``` - -If you want to add in the full history later on, perhaps to run `git blame` or `git log`, run `git fetch --depth=1000000` - -#### Building iD - -1. `cd` into the newly cloned project folder -2. Run `npm install` -3. Run `npm run all` -3. Run `npm start` -4. Open `http://127.0.0.1:8080/` in a web browser - -For guidance on building a packaged version, running tests, and contributing to -development, see [CONTRIBUTING.md](CONTRIBUTING.md). - +Follow the steps in the [how to get started guide](https://github.com/openstreetmap/iD/wiki/How-to-get-started#build-and-test-instructions) on how to install, build and run iD locally. ## License