Skip to content

Commit 1cca618

Browse files
committed
Writing new documentations.
1 parent 80e2217 commit 1cca618

File tree

5 files changed

+60
-40
lines changed

5 files changed

+60
-40
lines changed

Doxyfile

-40
Original file line numberDiff line numberDiff line change
@@ -1252,46 +1252,6 @@ USE_HTAGS = NO
12521252

12531253
VERBATIM_HEADERS = YES
12541254

1255-
# If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the
1256-
# clang parser (see:
1257-
# http://clang.llvm.org/) for more accurate parsing at the cost of reduced
1258-
# performance. This can be particularly helpful with template rich C++ code for
1259-
# which doxygen's built-in parser lacks the necessary type information.
1260-
# Note: The availability of this option depends on whether or not doxygen was
1261-
# generated with the -Duse_libclang=ON option for CMake.
1262-
# The default value is: NO.
1263-
1264-
CLANG_ASSISTED_PARSING = NO
1265-
1266-
# If the CLANG_ASSISTED_PARSING tag is set to YES and the CLANG_ADD_INC_PATHS
1267-
# tag is set to YES then doxygen will add the directory of each input to the
1268-
# include path.
1269-
# The default value is: YES.
1270-
# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES.
1271-
1272-
CLANG_ADD_INC_PATHS = YES
1273-
1274-
# If clang assisted parsing is enabled you can provide the compiler with command
1275-
# line options that you would normally use when invoking the compiler. Note that
1276-
# the include paths will already be set by doxygen for the files and directories
1277-
# specified with INPUT and INCLUDE_PATH.
1278-
# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES.
1279-
1280-
CLANG_OPTIONS =
1281-
1282-
# If clang assisted parsing is enabled you can provide the clang parser with the
1283-
# path to the directory containing a file called compile_commands.json. This
1284-
# file is the compilation database (see:
1285-
# http://clang.llvm.org/docs/HowToSetupToolingForLLVM.html) containing the
1286-
# options used when the source files were built. This is equivalent to
1287-
# specifying the -p option to a clang tool, such as clang-check. These options
1288-
# will then be passed to the parser. Any options specified with CLANG_OPTIONS
1289-
# will be added as well.
1290-
# Note: The availability of this option depends on whether or not doxygen was
1291-
# generated with the -Duse_libclang=ON option for CMake.
1292-
1293-
CLANG_DATABASE_PATH =
1294-
12951255
#---------------------------------------------------------------------------
12961256
# Configuration options related to the alphabetical class index
12971257
#---------------------------------------------------------------------------

docs/BAREMETAL.md

+34
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# Building for the bare metal target
2+
3+
In this file, we explain how to build your code for the bare metal target.
4+
In this case, the word bare metal means the Raspberry Pi Pico or Pico2.
5+
6+
We see two ways to build
7+
- CLI ( Command Line Interface )
8+
- VS Code ( Visual Studio Code )
9+
10+
## Configuration and building on CLI
11+
To build the program for the Raspberry Pi Pico, run the following commands :
12+
```sh
13+
cmake -B build -S . \
14+
-DCMAKE_C_COMPILER=/usr/bin/arm-none-eabi-gcc \
15+
-DCMAKE_CXX_COMPILER=/usr/bin/arm-none-eabi-g++
16+
cmake --build build --target all
17+
```
18+
19+
In the case you want to build the program for the Raspberry Pi Pico2, you need to define the variables PICO_PLATFORM and PICO_BOARD.
20+
21+
```sh
22+
cmake -B build -S . \
23+
-DPICO_PLATFORM=rp2350 -DPICO_BOARD=pico2 \
24+
-DCMAKE_C_COMPILER=/usr/bin/arm-none-eabi-gcc \
25+
-DCMAKE_CXX_COMPILER=/usr/bin/arm-none-eabi-g++
26+
cmake --build build --target all
27+
```
28+
29+
## Configuration and building on VS Code
30+
![](../image/cmake-ext.png)
31+
![](../image/selecting-kit.png)
32+
## How to run the application
33+
34+
## How to run the test

docs/WINLIN.md

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# Building for the bare metal target
2+
3+
In this file, we explain how to build your code for the bare metal target.
4+
In this case, the word bare metal means the Raspberry Pi Pico or Pico2.
5+
6+
We see two ways to build
7+
- CLI ( Command Line Interface )
8+
- VS Code ( Visual Studio Code )
9+
10+
## Configuration and building on CLI
11+
12+
```sh
13+
cmake -B build -S . \
14+
-DCMAKE_C_COMPILER=gcc \
15+
-DCMAKE_CXX_COMPILER=g++
16+
cmake --build build --target all
17+
```
18+
19+
20+
21+
22+
## Configuration and building on VS Code
23+
24+
## How to run the application
25+
26+
## How to run the test

image/cmake-ext.png

41 KB
Loading

image/selecting-kit.png

52.5 KB
Loading

0 commit comments

Comments
 (0)