Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
ZachGarcia42 committed May 14, 2024
1 parent 3be5a68 commit 4ce6757
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@ This is the code for receiving rocket telemetry, controlling the motor and servo
## Building:
Use CMake to build by running `cmake .. && make` from the `RATS-Software/build` directory. You can make this directory by running `mkdir build` if needed.

There are two flags to be aware of: DEBUG and MOVER. Both are currently disabled by default. Enabling DEBUG will print verbose information such as the radio transmission metadata and the calculated relative position of the rocket. Enabling MOVER will actuate the servo and stepper to aim the antenna at the calculated position. To toggle these flags, add the `-D<FLAG>=[ON|OFF]` to the cmake comment. For example:
There are two flags to be aware of: DEBUG and MOVER. DEBUG prints verbose information such as the radio transmission metadata and the calculated relative position of the rocket. MOVER actuates the servo and stepper to aim the antenna at the calculated position. The normal cmake commands builds four targets, one for each permutation of these flags:
1. rats
2. rats-debug
3. rats-move
4. rats-move-debug

`cmake -DDEBUG=ON -DMOVER=ON .. && make`

`cmake -DDEBUG=ON .. && make`

`cmake -DMOVER=ON .. && make`
Where each target

## Board Manager:
[pico-sdk](https://github.com/raspberrypi/pico-sdk)
Expand Down

0 comments on commit 4ce6757

Please sign in to comment.