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/start-here/initial-setup.mdx
+18-6Lines changed: 18 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -24,14 +24,26 @@ Follow Microsoft's official guide to install WSL: https://learn.microsoft.com/en
24
24
## Linux/WSL
25
25
26
26
<Steps>
27
-
1. Open a terminal and run the following commands to install our required tools:
27
+
1. Ensure you have Git installed. If you are using Ubuntu 24.04 LTS or later, or installed the default WSL distribution, you should already have it installed.
28
+
If not, open a terminal and run the following command to install Git:
29
+
30
+
```shell
31
+
sudo apt install git
32
+
```
33
+
34
+
2. Run the following command in a directory of your choice to clone the repository:
2. Install Python 3.11+ and pip. If you are using Ubuntu 24.04 LTS or later, or installed the default WSL distribution, you should already have a compatible version of Python installed.
46
+
4. Install Python 3.11+ and pip. If you are using Ubuntu 24.04 LTS or later, or installed the default WSL distribution, you should already have a compatible version of Python installed.
35
47
36
48
```shell
37
49
sudo apt install python3
@@ -45,29 +57,29 @@ Follow Microsoft's official guide to install WSL: https://learn.microsoft.com/en
45
57
```
46
58
If it's 3.11 or higher, you're good.
47
59
48
-
3. Install the Python virtual environment:
60
+
5. Install the Python virtual environment:
49
61
50
62
```shell
51
63
sudo apt install python3-venv
52
64
```
53
65
54
-
4. Setup your virtual environment by running the following commands in the repository's root directory:
66
+
6. Setup your virtual environment by running the following commands in the repository's root directory (the `OBC-firmware` folder):
55
67
56
68
```shell
57
69
python3 -m venv .venv
58
70
source .venv/bin/activate
59
71
pip install -r requirements.txt
60
72
pip install -e .
61
73
62
-
5. Setup pre-commit:
74
+
7. Setup pre-commit:
63
75
64
76
```shell
65
77
# The first command installs Deno, which is required for our pre-commit
66
78
curl -fsSL https://deno.land/install.sh | sh
67
79
pre-commit install
68
80
```
69
81
70
-
6.
82
+
8.
71
83
:::note[Ground station only]
72
84
Setup the PostgreSQL database with the [Database setup](/OBC-firmware/start-here/database-setup) guide.
0 commit comments