Robin-van-der-Linde/MapComplete
1
0
Fork 0
forked from MapComplete/MapComplete
Code Pull requests Activity

Improve developer documentation for initial set up (#1007)

Browse source 
* Use correct path to tool-versions

Signed-off-by: Robbert Gurdeep Singh <git@beardhatcode.be>

* Add python3 to install steps

Signed-off-by: Robbert Gurdeep Singh <git@beardhatcode.be>

* Use consistent markdown

Signed-off-by: Robbert Gurdeep Singh <git@beardhatcode.be>

* Mention that nix-env is for Nix users

Signed-off-by: Robbert Gurdeep Singh <git@beardhatcode.be>

* Add note on how to install python3

Signed-off-by: Robbert Gurdeep Singh <git@beardhatcode.be>
This commit is contained in:
Robbert Gurdeep Singh 2022-07-30 15:07:55 +02:00 committed by GitHub
parent e4290b4190
commit b96bc9031d
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
Docs/Development_deployment.md
View file

@ -27,7 +27,10 @@ Devcontainer (see more details later).
To develop and build MapComplete, you To develop and build MapComplete, you
0. Make a fork and clone the repository. (We recommend a shallow clone with `git clone --filter=blob:none <repo>`) 0. Make a fork and clone the repository. (We recommend a shallow clone with `git clone --filter=blob:none <repo>`)
0. Install the nodejs version specified in [.tool-versions](./.tool-versions) 0. Install `python3` if you do not have it already
- On linux: `sudo apt install python3`
- On windows: find the latest download on the [Python Releases for Windows page](https://www.python.org/downloads/windows/)
0. Install the nodejs version specified in [/.tool-versions](/.tool-versions)
- On linux: install npm first `sudo apt install npm`, then install `n` using npm: ` npm install -g n`, which can - On linux: install npm first `sudo apt install npm`, then install `n` using npm: ` npm install -g n`, which can
then install node with `n install <node-version>` then install node with `n install <node-version>`
- You can [use asdf to manage your runtime versions](https://asdf-vm.com/). - You can [use asdf to manage your runtime versions](https://asdf-vm.com/).
@ -72,11 +75,12 @@ To use the WSL in Visual Studio Code:
or `userlayout=true#<layout configuration>` as [Query parameter](URL_Parameters.md). Note that the shorter URLs ( or `userlayout=true#<layout configuration>` as [Query parameter](URL_Parameters.md). Note that the shorter URLs (
e.g. `bookcases.html`, `aed.html`, ...) _don't_ exist on the development version. e.g. `bookcases.html`, `aed.html`, ...) _don't_ exist on the development version.
### Dependencie Dependencies
------------
`make` , `python3` `g++` `make` , `python3` `g++`
(run `nix-env -iA nixos.gnumake nixos.gdc nixos.python3`) (Nix users may run `nix-env -iA nixos.gnumake nixos.gdc nixos.python3`)
Automatic deployment Automatic deployment
-------------------- --------------------