You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/src/content/docs/builds/build-obc.mdx
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -25,7 +25,7 @@ The following is a simple guide for building the app for the OBC and flashing.
25
25
1.`make -j 16` (Recommended for most systems)
26
26
2.`make -j 32` (This is faster but depends on if your system can handle 32 parallel jobs)
27
27
:::
28
-
2. There are also plenty of extra options that you can use besides `-DCMAKE_BUILD_TYPE` by appending them to the `cmake ..` command. Take a look at the [CMake Options Guide](/OBC-firmware/getting-started/cmake-options/).
28
+
2. There are also plenty of extra options that you can use besides `-DCMAKE_BUILD_TYPE` by appending them to the `cmake ..` command. Take a look at the [CMake Options Guide](/OBC-firmware/builds/cmake-options/).
29
29
30
30
:::caution
31
31
Make sure to specify the `-DBOARD_TYPE=` option to avoid any unwanted behavior
Welcome to the Orbital Docs! Here you will find all codebase-related documentation.
13
+
14
+
:::caution
15
+
These docs are a work in-progress. As such not everything may be documented. If you need something and you do not find it in the documentation, be sure to mention it on our Discord server so that it can be added!
16
+
:::
17
+
18
+
## About the team
19
+
> UW Orbital is a student design team at the University of Waterloo participating in the Canadian Satellite Design Challenge (CSDC) - a competition that involves a dozen universities from across Canada and runs every two years. Teams design a 3U CubeSats with unique missions and payloads, and attempt to pass launch readiness evaluations such as vibration testing. The competition offers to fund the launch costs for the winning team.
20
+
21
+
**You can find out more on our site:**[https://www.uworbital.com/](https://www.uworbital.com/)
22
+
23
+
## What software does
24
+
Software is a sub-team consisting of two major code projects: the ground station and the satellite.
25
+
26
+
Ground station related code includes coding front-ends that operators can interact with as well as code that interfaces with the satellite. The ground station mostly consists of Python and React.
27
+
28
+
The satellite related code includes coding firmware for our onboard computer (OBC) and electrical systems (e.g. BMS). This is a major portion of the codebase and helps the software team enable the creations from the mechanical and electrical sub-teams.
29
+
30
+
## Suggested Guides
31
+
Don't know where to go first? Try one of the following links!
32
+
33
+
<LinkCardtitle="The build guide for firmware"href="/OBC-firmware/builds/build-obc/" />
34
+
<LinkCardtitle="The build guide for ground station"href="/OBC-firmware/builds/build-gs/" />
35
+
<LinkCardtitle="The style guide for the code we write"href="/OBC-firmware/getting-started/style-guide/" />
36
+
<LinkCardtitle="An overview of our codebase's file structure"href="/OBC-firmware/getting-started/file-structure/" />
0 commit comments