Skip to content

Commit f5fb4b9

Browse files
mbrossardmbrossard
committed
doc: move build instructions from README.md to docs/DEVELOPERS-GUIDE.md
1 parent 27037b1 commit f5fb4b9

File tree

2 files changed

+81
-184
lines changed

2 files changed

+81
-184
lines changed

‎README.md‎

Lines changed: 15 additions & 96 deletions
Original file line numberDiff line numberDiff line change
@@ -1,102 +1,15 @@
1-
# Warning: Development branch
2-
3-
This is is a development branch:
4-
- It adds support for the GCC (`gcc_arm`) and ARMC6 (`armclang`) compilers, ARMC5 (`armcc`) will be deprecated.
5-
- It focuses on `progen` support using `make` and `cmake`.
6-
7-
## Setup
8-
9-
DAPLink sources are compiled using `progen` (from [project-generator](https://github.com/project-generator/project_generator)) which can be run on Linux, MacOS and Windows.
10-
11-
Install the necessary tools listed below. Skip any step where a compatible tool already exists.
12-
13-
* Install [Python 3](https://www.python.org/downloads/) . Add to PATH.
14-
* Install [Git](https://git-scm.com/downloads) . Add to PATH.
15-
* Install a compiler:
16-
* [GNU Arm Embedded Toolchain](https://developer.arm.com/tools-and-software/open-source-software/developer-tools/gnu-toolchain/gnu-rm/downloads) . This compiler will be identified as `gcc_arm`.
17-
* [Arm Compiler 6](https://developer.arm.com/tools-and-software/embedded/arm-compiler) . This compiler will be identified as `armclang`. Only supported on Linux and Windows.
18-
* [Keil MDK](https://developer.arm.com/tools-and-software/embedded/keil-mdk) or [Arm Compiler 5](https://developer.arm.com/tools-and-software/embedded/arm-compiler/downloads/legacy-compilers#arm-compiler-5). This compiler will be identified as `armcc`. Only supported on Linux and Windows.
19-
* Install `make` (tested with [GNU Make](https://www.gnu.org/software/make)). [CMake](https://cmake.org) can alternatively be used in conjunction with different implementations of `make` as well as [ninja](https://ninja-build.org).
20-
* Install virtualenv in your global Python installation eg: `pip install virtualenv`.
21-
22-
**Step 1.** Initial setup.
23-
24-
Get the sources and create a virtual environment
25-
26-
```
27-
$ git clone https://github.com/ARMmbed/DAPLink
28-
$ cd DAPLink
29-
$ git checkout develop
30-
$ virtualenv venv
31-
```
32-
33-
## Activate virtual environment
34-
**Step 2.** Activate the virtual environment and update requirements. This is necessary when you open a new shell. **This should be done every time you pull new changes**
35-
36-
```
37-
$ venv/Scripts/activate (For Linux)
38-
$ venv/Scripts/activate.bat (For Windows)
39-
(venv) $ pip install -r requirements.txt
40-
```
41-
42-
## Build
43-
**This should be done every time you pull new changes**
441

45-
You can use the `progen` command-line tool from project-generator or the `tools/progen_compile.py` wrapper tool.
2+
[![DAPLink](/docs/images/daplink-website-logo-link.png)](https://daplink.io/)
463

47-
**Step 4.1.** Using `progen_compile.py`
4+
[![Linux Build (develop)](https://github.com/ARMmbed/DAPLink/actions/workflows/linux.yml/badge.svg?branch=develop)](https://github.com/ARMmbed/DAPLink/actions/workflows/linux.yml)
485

49-
```
50-
(venv) $ python tools/progen_compile.py [-t <tool>] [--clean] [-v] [--parallel] [<project> [<project> ...]]
51-
```
52-
53-
* `-t <tool>`: choose the toolchain to build. The default is `make_gcc_arm`. Other options tested are `make_gcc_arm`, `make_armclang`, `make_armcc`, `cmake_gcc_arm`, `cmake_armclang`, `cmake_armcc`.
54-
* `--clean`: will clear existing compilation products and force recompilation of all files.
55-
* `-v`: will make compilation process more verbose (typically listing all commands with their arguments)
56-
* `--parallel`: enable parallel compilation within a project (projects are compiled sequentially).
57-
* `<project>`: target project to compile (e.g. `stm32f103xb_bl`, `lpc11u35_if`), if none is specified all (140 to 150) projects will be compiled.
58-
59-
**Step 4.2.** Using `progen` with `make`
60-
61-
The following command combines generation and compilation:
62-
63-
```
64-
(venv) $ progen generate -t make_gcc_arm -p <project> -b
65-
```
66-
67-
Alternatively one can separate those task:
68-
```
69-
(venv) $ progen generate -t make_gcc_arm -p <project>
70-
(venv) $ make -C projectfiles/make_gcc_arm/<project> [<target>] [VERBOSE=1]
71-
```
72-
Where:
73-
* `<project>`: target project to compile (e.g. `stm32f103xb_bl`, `lpc11u35_if`).
74-
* `<target>`: build target, can be `all`, `clean` or `help`.
75-
* `VERBOSE=1`: display additional compilation information.
76-
77-
**Step 4.3.** Using `progen` with `cmake`
78-
79-
The following command combines generation and compilation:
80-
81-
```
82-
(venv) $ progen generate -t cmake_gcc_arm -o generator=<generator> -p <project> -b
83-
```
84-
* `<generator>`: use `CMake` generators among the following options:
85-
* `make` (`Unix Makefiles`)
86-
* `mingw-make` (`MinGW Makefiles`)
87-
* `msys-make` (`MSYS Makefiles`, untested)
88-
* `ninja` (`Ninja`)
89-
* `nmake` (`NMake Makefiles`, untested)
90-
* `<project>`: target project to compile (e.g. `stm32f103xb_bl`, `lpc11u35_if`).
91-
92-
# End of warning
6+
# Warning: Development branch
937

94-
[![DAPLink](/docs/images/daplink-website-logo-link.png)](https://armmbed.github.io/DAPLink/)
8+
This is is a development branch of DAPLink:
9+
- It adds support for the GCC (`gcc_arm`) and ARMC6 (`armclang`) compilers. ARMC5 (`armcc`) will be deprecated.
10+
- It focuses on `progen` support using `make` and `cmake`.
9511

96-
**Note:** The master branch requires an Arm Compiler 5 or Keil MDK license to build. See the
97-
[develop](https://github.com/ARMmbed/DAPLink/tree/develop) branch for gcc and Arm
98-
Compiler 6 support. As soon as testing is complete, gcc will become the default compiler and AC5 support will be
99-
dropped.
12+
**Note:** The main branch of DAPLink requires an Arm Compiler 5 or Keil MDK license to build.
10013

10114
----
10215

@@ -114,12 +27,18 @@ For more detailed usability information [see the users guide.](docs/USERS-GUIDE.
11427

11528
## Compatibility
11629
There are many ARM microcontroller-based Hardware Interface Circuits (HICs) that DAPLink interface firmware runs on. These can be found as standalone boards (debugger) or as part of a development kit. Some branded circuits that are known to be IO compatible are:
117-
* [NXP OpenSDA based on K20, K22 and KL26](http://www.nxp.com/products/software-and-tools/run-time-software/kinetis-software-and-tools/ides-for-kinetis-mcus/opensda-serial-and-debug-adapter:OPENSDA)
30+
31+
* [Maxim Integrated MAX32625PICO based on MAX32625](https://www.maximintegrated.com/en/products/microcontrollers/MAX32625PICO.html)
32+
* Nuvoton Nu-Link2-Me based on M48SSIDAE
11833
* [NXP LPC-Link2 based on LPC11U35 or LPC4322](https://www.nxp.com/support/developer-resources/hardware-development-tools/lpcxpresso-boards:LPCXPRESSO-BOARDS)
34+
* [NXP MCU-LINK on LPC55xx](https://www.nxp.com/design/microcontrollers-developer-resources/mcu-link-debug-probe:MCU-LINK)
35+
* [NXP OpenSDA based on K20, K22, KL26Z and KL27Z](http://www.nxp.com/products/software-and-tools/run-time-software/kinetis-software-and-tools/ides-for-kinetis-mcus/opensda-serial-and-debug-adapter:OPENSDA)
11936
* [Segger J-Link OB based on Atmel SAM3U](https://www.segger.com/products/debug-probes/j-link/models/j-link-ob/)
37+
* [STMicroelectronics ST-LINK/V2 (on NUCLEO boards) based on STM32F103CB](https://www.st.com/en/evaluation-tools/stm32-nucleo-boards.html)
38+
12039

12140
## Releases
122-
There are many board builds (board = HIC + target combination) created from this repository. Quarterly releases will contain new features and bugfixes. Standalone bugfixes are released once reported, verified and fixed. Both quarterly and bugfix releases will result in the build number being incremented. Many development kits and products ship with DAPLink interface firmware or are capable of running DAPLink firmware. **[The current release builds and instructions for updating DAPLink interface firmware is hosted on the DAPLink release site.](https://armmbed.github.io/DAPLink/)** Release notes and previous release builds can be found under GitHub releases.
41+
There are many board builds (board = HIC + target combination) created from this repository. Quarterly releases will contain new features and bugfixes. Standalone bugfixes are released once reported, verified and fixed. Both quarterly and bugfix releases will result in the build number being incremented. Many development kits and products ship with DAPLink interface firmware or are capable of running DAPLink firmware. **[The current release builds and instructions for updating DAPLink interface firmware is hosted on the DAPLink release site.](https://daplink.io/)** Release notes and previous release builds can be found under GitHub releases.
12342

12443
## Contribute
12544

0 commit comments

Comments
 (0)