You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: DEVELOPMENT.md
+6-5
Original file line number
Diff line number
Diff line change
@@ -28,13 +28,13 @@ The Dockerfile is organized as a multi-stage build.
28
28
4. The build artifacts are copied in a final scratch image where they are ready to be copied out to the host.
29
29
30
30
## Local Development environment setup
31
-
Two approaches are possible, using docker to run builds in a reproducible environment or building it locally setting up the local machine.
31
+
Two approaches to local development are possible, the first is using docker to run builds in a reproducible environment, the second is building the code locally without docker.
32
32
33
33
Note that all the options mentioned statically link Proj to the final build executable, this ensures the system builds a single highly portable binary that embeds all required dependencies.
34
34
35
35
### Option 1. Install docker and use `build.sh` or `build.ps1` to build the code and run the tests.
36
36
37
-
The pro here is that this should work in any environment and ensures that the final executable build is reproducible. It recommended to always run a "dockerized" build before creating a PR.
37
+
The benefit of using Dockerized builds is enabling reproducible builds. It recommended to always run a "dockerized" build before creating a PR.
38
38
39
39
To build just run in a powershell console:
40
40
```
@@ -43,12 +43,13 @@ To build just run in a powershell console:
43
43
44
44
### Option 2. Setup the local machine for local development without Docker.
45
45
46
-
This approach is more challenging and the steps are different depending whether you are development under Windows or Linux. In general the environment needs to be set up mimicking the steps described in the `Dockerfile`.
46
+
This approach is more challenging and the steps are different depending whether you are developing under Windows or Linux. In general the environment needs to be set up mimicking the steps described in the `Dockerfile`.
47
47
48
-
Since the dockerfile has been written designed to run builds in Linux, that is also documenting how to setup a linux dev environment. In the following we will focus mostly instead on the steps to setup a dev environment under Windows.
48
+
The provided Dockerfile has been written to run builds in Linux, and as such it is also documenting how to setup a local Linux dev environment.
49
+
For this reason, in the following we will focus mostly instead on the steps needed to setup a dev environment under Windows.
49
50
50
51
### **Setup a Windows development environment**
51
-
The commands in the following are supposed to be executed from a powershell console.
52
+
The commands that follow are supposed to be executed from a Powershell console.
0 commit comments