Skip to content

Commit 4f80692

Browse files
authored
Update build.md
Make it clear how to select master vs develop branch, and that develop is used by default.
1 parent 5916cea commit 4f80692

File tree

1 file changed

+26
-2
lines changed

1 file changed

+26
-2
lines changed

en/contributing/build.md

Lines changed: 26 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,10 +27,22 @@ To build the *DroneCore* C++ Library on Linux (or macOS after installing the [pr
2727
```
2828
> **Note** If the build reports a missing dependency, confirm that the set above matches the requirements in the [Dockerfile](https://github.com/dronecore/DroneCore/blob/master/Dockerfile).
2929
30-
1. Clone the [DroneCore repository](https://github.com/dronecore/DroneCore) (or your fork) and update the submodules:
30+
1. Clone the [DroneCore repository](https://github.com/dronecore/DroneCore) (or your fork):
3131
```sh
3232
git clone https://github.com/dronecore/DroneCore.git
3333
cd DroneCore
34+
```
35+
1. Checkout the release/branch you want to build (the `develop` branch is checked out by default).
36+
* Latest stable build (`master`):
37+
```
38+
git checkout master
39+
```
40+
* Head revision with latest features (`develop`):
41+
```
42+
git checkout develop
43+
```
44+
1. Update the submodules:
45+
```sh
3446
git submodule update --init --recursive
3547
```
3648
1. Build the (debug) C++ library by calling:
@@ -61,10 +73,22 @@ To build the library in Windows, you need:
6173
> **Note** The instructions below assume you downloaded [curl-7.56.1.zip](https://curl.haxx.se/download/curl-7.56.1.zip) and extracted to the root of your C drive. You can use a different *curl* if you want.
6274

6375
To build the *DroneCore* C++ Library on Windows:
64-
1. Clone the DroneCore repository (or your fork) and update the submodules:
76+
1. Clone the [DroneCore repository](https://github.com/dronecore/DroneCore) (or your fork):
6577
```sh
6678
git clone https://github.com/dronecore/DroneCore.git
6779
cd DroneCore
80+
```
81+
1. Checkout the release/branch you want to build (the `develop` branch is checked out by default).
82+
* Latest stable build (`master`):
83+
```
84+
git checkout master
85+
```
86+
* Head revision with latest features (`develop`):
87+
```
88+
git checkout develop
89+
```
90+
1. Update the submodules:
91+
```sh
6892
git submodule update --init --recursive
6993
```
7094
1. Download the [curl-7.56.1.zip](https://curl.haxx.se/download/curl-7.56.1.zip) source and extract it to the root of your C drive.

0 commit comments

Comments
 (0)