Skip to content

Commit fb3be71

Browse files
committed
Update README with new build instructions
1 parent f99a64a commit fb3be71

File tree

1 file changed

+13
-14
lines changed

1 file changed

+13
-14
lines changed

README.md

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -2,39 +2,38 @@
22

33
[![Actions Status](https://github.com/badgerloop-software/pod-embedded/workflows/CI/badge.svg)](https://github.com/badgerloop-software/pod-embedded/actions)
44

5-
*Developers: Rohan Daruwala, Ezra Boley*
5+
*Developers: Rohan Daruwala, Ezra Boley, Nic Hodlofski*
66

77
The embedded repository for Badgerloop's pod in the Hyperloop Competition
88

99
## Beaglebone Make Instructions
1010

11-
There are currently 3 sets of targets:
11+
To build all compile targets:
1212

13-
1) Making the main programs (`badgerloop_LV` and `badgerloop_HV`), placed in the `out/` folder
13+
1) Make a directory called build in the root of the repository and enter it
1414

1515
```
16-
make
16+
mkdir build
17+
cd build
1718
```
1819

19-
The main target can also be executed in a special debug mode, adding useful
20-
print outs from various modules. Any of the following targets can also take
21-
advantage of the added debug functionality. To build in debug mode, run:
20+
2) Run cmake on the parent directory
2221

2322
```
24-
make DEBUG=1
23+
cmake ..
2524
```
2625

27-
2) Making the examples, placed into the `out/tests` folder
26+
3) Build the project with make
2827

2928
```
30-
make examples
29+
make
3130
```
3231

33-
3) Making utilities for showcasing various parts of the pod's functionality
32+
There are currently 3 sets of targets:
3433

35-
```
36-
make utils
37-
```
34+
The main programs (`badgerloop_LV` and `badgerloop_HV`) are placed in the `out/` directory
35+
36+
Tests will be placed in `out/tests`, and utilities in `out/utils`.
3837

3938
### Adding Tests
4039

0 commit comments

Comments
 (0)