Skip to content

Commit e1fbb68

Browse files
committed
Add clone repo step
1 parent b281d6b commit e1fbb68

File tree

1 file changed

+18
-6
lines changed

1 file changed

+18
-6
lines changed

docs/src/content/docs/start-here/initial-setup.mdx

Lines changed: 18 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -24,14 +24,26 @@ Follow Microsoft's official guide to install WSL: https://learn.microsoft.com/en
2424
## Linux/WSL
2525

2626
<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:
35+
```shell
36+
git clone https://github.com/UWOrbital/OBC-firmware.git
37+
```
38+
39+
3. Install our required tools:
2840

2941
```shell
3042
sudo apt update
3143
sudo apt install -y build-essential gcc-multilib g++-multilib cmake curl
3244
```
3345

34-
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.
3547

3648
```shell
3749
sudo apt install python3
@@ -45,29 +57,29 @@ Follow Microsoft's official guide to install WSL: https://learn.microsoft.com/en
4557
```
4658
If it's 3.11 or higher, you're good.
4759

48-
3. Install the Python virtual environment:
60+
5. Install the Python virtual environment:
4961

5062
```shell
5163
sudo apt install python3-venv
5264
```
5365

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):
5567

5668
```shell
5769
python3 -m venv .venv
5870
source .venv/bin/activate
5971
pip install -r requirements.txt
6072
pip install -e .
6173

62-
5. Setup pre-commit:
74+
7. Setup pre-commit:
6375

6476
```shell
6577
# The first command installs Deno, which is required for our pre-commit
6678
curl -fsSL https://deno.land/install.sh | sh
6779
pre-commit install
6880
```
6981

70-
6.
82+
8.
7183
:::note[Ground station only]
7284
Setup the PostgreSQL database with the [Database setup](/OBC-firmware/start-here/database-setup) guide.
7385
:::

0 commit comments

Comments
 (0)