Improve developer documentation for initial set up (#1007)
* 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:
parent
e4290b4190
commit
b96bc9031d
1 changed files with 7 additions and 3 deletions
|
@ -27,7 +27,10 @@ Devcontainer (see more details later).
|
|||
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. 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
|
||||
then install node with `n install <node-version>`
|
||||
- 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 (
|
||||
e.g. `bookcases.html`, `aed.html`, ...) _don't_ exist on the development version.
|
||||
|
||||
### Dependencie
|
||||
Dependencies
|
||||
------------
|
||||
|
||||
`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
|
||||
--------------------
|
||||
|
|
Loading…
Reference in a new issue