Skip to content
This repository has been archived by the owner on Apr 18, 2024. It is now read-only.

Update documentation #209

Merged
merged 6 commits into from
Mar 4, 2019
Merged
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 16 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -218,16 +218,16 @@ The following steps are needed only if you want to compile your own `connectivit
$ choco install -y make
```

2. Install `GNU Embedded Toolchain for Arm`
```bash
$ choco install -y gcc-arm-embedded
```
2. Download and install `GNU Embedded Toolchain for Arm` version 7-2018q2
[Download](https://developer.arm.com/-/media/Files/downloads/gnu-rm/7-2018q2/gcc-arm-none-eabi-7-2018-q2-update-win32-sha2.exe?revision=bc72768f-9927-454e-9141-918927fb74ff?product=GNU%20Arm%20Embedded%20Toolchain,32-bit,,Windows,7-2018-q2-update)

Follow the install instructions.

Set its installation path as `GCCARMEMB_TOOLCHAIN_PATH` in environment variables.
By default:

```bash
$ SET GCCARMEMB_TOOLCHAIN_PATH=C:\ProgramData\chocolatey\lib\gcc-arm-embedded\tools
$ set GCCARMEMB_TOOLCHAIN_PATH=C:\ProgramData\chocolatey\lib\gcc-arm-embedded\tools
```

3. Install `Python` and `pip`, and then install `nrfutil`
Expand Down Expand Up @@ -275,7 +275,7 @@ The following steps are needed only if you want to compile your own `connectivit

The following steps are needed only if you want to compile your own `connectivity` HEX files.

1. Install `GNU Embedded Toolchain for Arm`.
1. Install `GNU Embedded Toolchain for Arm` version 7-2018q2.
* Download from [here](https://developer.arm.com/open-source/gnu-toolchain/gnu-rm/downloads)
* Extract
* Set its location as `GCCARMEMB_TOOLCHAIN_PATH` in environment variables.
Expand Down Expand Up @@ -315,7 +315,7 @@ The following steps are needed only if you want to compile your own `connectivit

The following steps are needed only if you want to compile your own `connectivity` HEX files.

1. Install `GNU Embedded Toolchain for Arm`
1. Install `GNU Embedded Toolchain for Arm` version 7-2018q2.
* Download from [here](https://developer.arm.com/open-source/gnu-toolchain/gnu-rm/downloads)
* Extract
* Set its location as `GCCARMEMB_TOOLCHAIN_PATH` in environment variables.
Expand Down Expand Up @@ -350,27 +350,27 @@ The following steps are needed only if you want to compile your own `connectivit

To build 32-bit version with Visual Studio 2015:
```bash
$ cmake -G "Visual Studio 14" -DCMAKE_TOOLCHAIN_FILE=%VCPKG_ROOT%\scripts\buildsystems\vcpkg.cmake ..
$ cmake -G "Visual Studio 14" ..
```

To build 64-bit version with Visual Studio 2015:

```bash
$ cmake -G "Visual Studio 14 Win64" -DCMAKE_TOOLCHAIN_FILE=%VCPKG_ROOT%\scripts\buildsystems\vcpkg.cmake ..
$ cmake -G "Visual Studio 14 Win64" ..
```

Change `-G "Visual Studio 14"` to `-G "Visual Studio 15"` if you are using Visual Studio 2017.

3. MSBuild

```bash
$ msbuild ALL_BUILD.vcxproj
$ cmake --build .
```

Optionally select the build configuration with the `/p:Configuration=` option. Typically `Debug`, `Release`, `MinSizeRel` and `RelWithDebInfo` are available. For example:
Optionally select the build configuration with the `--config` option. Typically `Debug`, `Release`, `MinSizeRel` and `RelWithDebInfo` are available. For example:

```bash
$ msbuild ALL_BUILD.vcxproj /p:Configuration=Debug
$ cmake --build . --config Debug
```

#### Compiling pc-ble-driver on Ubuntu Linux or macOS
Expand All @@ -391,7 +391,6 @@ The following steps are needed only if you want to compile your own `connectivit
```bash
$ cmake \
-G "Unix Makefiles" \
-DCMAKE_TOOLCHAIN_FILE=$VCPKG_ROOT/scripts/buildsystems/vcpkg.cmake \
..
```

Expand All @@ -403,15 +402,14 @@ The following steps are needed only if you want to compile your own `connectivit
```bash
$ cmake \
-G "Unix Makefiles" \
-DCMAKE_TOOLCHAIN_FILE=$VCPKG_ROOT/scripts/buildsystems/vcpkg.cmake \
-DCMAKE_BUILD_TYPE=Debug \
-DARCH=x86_32,x86_64 \
..
```

3. Make
```bash
$ make
$ cmake --build .
```

---
Expand Down Expand Up @@ -445,11 +443,10 @@ Follow the steps to install dependencies on a specific platform:

2. CMake
```bash
$ cd hex
$ mkdir build && cd build

# Modify -DCONNECTIVITY_VERSION=a.b.c
$ cmake -G "Visual Studio 14" -DCMAKE_TOOLCHAIN_FILE=%VCPKG_ROOT%\scripts\buildsystems\vcpkg.cmake -DCOMPILE_CONNECTIVITY=1 -DCONNECTIVITY_VERSION=1.0.0 ..
$ cmake -G "Visual Studio 14" -DCOMPILE_CONNECTIVITY=1 -DCONNECTIVITY_VERSION=1.0.0 ..
```

`COMPILE_CONNECTIVITY` is set to 1 to enable compiling connectivity firmware.
Expand All @@ -460,7 +457,7 @@ Follow the steps to install dependencies on a specific platform:

3. MSBuild
```bash
$ msbuild compile_connectivity.vcxproj
$ cmake --build hex --target compile_connectivity
```

The HEX files are available in the `hex/sd_api_v<x>` folder after compilation. They include the SoftDevice and the connectivity application.
Expand All @@ -484,7 +481,6 @@ Follow the steps to install dependencies on a specific platform:
# Modify -DCONNECTIVITY_VERSION=a.b.c
$ cmake \
-G "Unix Makefiles" \
-DCMAKE_TOOLCHAIN_FILE=$VCPKG_ROOT/scripts/buildsystems/vcpkg.cmake \
-DCOMPILE_CONNECTIVITY=1 \
-DCONNECTIVITY_VERSION=1.0.0 \
..
Expand All @@ -498,7 +494,7 @@ Follow the steps to install dependencies on a specific platform:

3. Make
```bash
$ make compile_connectivity
$ cmake --build hex --target compile_connectivity
```

The HEX files are available in the `hex/sd_api_v<x>` folder after compilation. They include the SoftDevice and the connectivity application.
Expand Down