Skip to content

Commit d58bf85

Browse files
committed
Update README.md with new scripts
1 parent 968c3c7 commit d58bf85

File tree

1 file changed

+12
-4
lines changed

1 file changed

+12
-4
lines changed

README.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -189,23 +189,27 @@ pre-commit install
189189
From the top-level directory, run the following to build the OBC firmware.
190190

191191
```sh
192-
mkdir build_arm && cd build_arm
192+
mkdir -p build_arm && cd build_arm
193193
cmake .. -DCMAKE_BUILD_TYPE=OBC
194194
cmake --build .
195195
```
196196

197+
OR you can just run `./scripts/obc-build.sh` from the top-level directory.
198+
197199
Take a look at `cmake/fw_build_options.cmake` to see the available build options.
198200

199201
#### **Ground Station**
200202

201203
From the top-level directory, run the following to build the ground station. Currently, the ground station is only supported on Windows.
202204

203205
```sh
204-
mkdir build_gs && cd build_gs
206+
mkdir -p build_gs && cd build_gs
205207
cmake .. -DCMAKE_BUILD_TYPE=GS
206208
cmake --build .
207209
```
208210

211+
OR you can just run `./scripts/gs-build.sh` from the top-level directory.
212+
209213
#### **Tests**
210214

211215
**Note**: GNU cross-compilation tools are required to build the tests. If you haven't already, run the following before building:
@@ -218,22 +222,26 @@ sudo apt-get install gcc-multilib g++-multilib
218222
From the top-level directory, run the following to build and run the tests.
219223

220224
```sh
221-
mkdir build && cd build
225+
mkdir -p build && cd build
222226
cmake .. -DCMAKE_BUILD_TYPE=Test
223227
cmake --build .
224228
ctest --verbose
225229
```
226230

231+
OR you can just run `./scripts/test.sh` from the top-level directory.
232+
227233
#### **Example files**
228234

229235
From the top-level directory, run the following to build the example source file.
230236

231237
```sh
232-
mkdir build_examples && cd build_examples
238+
mkdir -p build_examples && cd build_examples
233239
cmake .. -DCMAKE_BUILD_TYPE=Examples -DEXAMPLE_TYPE=[EXAMPLE_TO_BE_COMPILED]
234240
cmake --build .
235241
```
236242

243+
OR you can just run `./scripts/example-build.sh [EXAMPLE_TO_BE_COMPILED]` from the top-level directory.
244+
237245
Options for `EXAMPLE_TYPE` include:
238246

239247
- `DMA_SPI` - for `dma_spi_demo`

0 commit comments

Comments
 (0)