Skip to content

Commit 20516ce

Browse files
committed
update README
1 parent 65e07d7 commit 20516ce

File tree

1 file changed

+45
-5
lines changed

1 file changed

+45
-5
lines changed

README.md

Lines changed: 45 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,52 @@ AM32 Bootloader
33

44
This is the bootloader for the AM32 project
55

6-
Building
6+
Installing Build Tools
7+
----------------------
8+
9+
To install the required build tools please run the script for your
10+
operating system found in the env_setup_scripts directory. This will
11+
download the required tools from
12+
https://firmware.ardupilot.org/Tools/AM32-tools/ and unpack them in
13+
tools. It will also setup your vscode settings for your OS.
14+
15+
Runing VSCode
16+
-------------
17+
18+
When you run vscode it will recommend you install some key extensions:
19+
20+
- C/C++ tools
21+
- Cortex-Debug
22+
- Makefile Tools
23+
24+
You will need to install these before doing a build.
25+
26+
Command Line Build
27+
------------------
28+
29+
To build with the command line use the command "make". If your
30+
environment is setup correctly you should be able to tab complete the
31+
available targets. Otherwise you can run "make targets" to see the
32+
available build targets.
33+
34+
CI Builds
35+
---------
36+
37+
All of the bootloaders are automatically built in CI using github
38+
actions. See the Actions tab on
39+
https://github.com/am32-firmware/AM32-bootloader for the latest
40+
builds.
41+
42+
Releases
743
--------
844

9-
The recommended build environment is vscode or command line make. You
10-
will need the tools from here
45+
The latest release is available here:
46+
47+
https://github.com/am32-firmware/AM32-bootloader/releases
1148

12-
https://firmware.ardupilot.org/Tools/AM32-tools/
49+
Getting Help
50+
------------
1351

14-
unpack the right tools for your OS before building
52+
If you need help with bootloader development please ask on the AM32
53+
discord server in the development channel
54+
https://discord.com/invite/h7ddYMmEVV

0 commit comments

Comments
 (0)