# Prerequisites

Follow this guide to:

- Set up a command-line PebbleOS development environment
- Get the source code

## PebbleOS SDK

Install the [PebbleOS SDK](https://github.com/coredevices/PebbleOS-SDK), which
bundles the ARM GNU toolchain, Pebble QEMU, and other tools:

```shell
curl -LsSf https://github.com/coredevices/PebbleOS-SDK/releases/latest/download/pebbleos-sdk-installer.sh | sh
```

## System-level dependencies

A series of system-level dependencies are required.
Follow the next steps to install them.

:::::{tab-set}
:sync-group: os

::::{tab-item} Ubuntu 24.04 LTS
:sync: ubuntu

1. Update first:

```shell
sudo apt update
```

2. Install required dependencies

```shell
sudo apt install \
    bison \
    clang \
    flex \
    gcc \
    gcc-multilib \
    gettext \
    git \
    gperf \
    libfreetype6-dev \
    libglib2.0-dev \
    libgtk-3-dev \
    libncurses-dev \
    librsvg2-bin \
    make \
    openocd \
    python3-dev \
    python3-venv
```

::::

::::{tab-item} Fedora 44

1. Upgrade first:

```shell
sudo dnf upgrade --refresh
```

2. Install required dependencies

```shell
sudo dnf install \
    clang \
    dash \
    freetype-devel \
    gcc \
    glib2-devel \
    gtk3-devel \
    librsvg2-tools \
    nodejs \
    python-devel  
```

::::

::::{tab-item} macOS

1. Install [brew](https://brew.sh/).

2. Install dependencies:

```shell
brew install librsvg python openocd
```

3. Link `brew` Python:

```shell
brew link python@3
```

::::

:::::

## Get the source code

You can clone the PebbleOS repository by running:

```shell
git clone --recurse-submodules https://github.com/coredevices/pebbleos
```

Once cloned, enter the `pebbleos` directory before continuing:

```shell
cd pebbleos
```

## Python dependencies

A series of additional Python dependencies are also required.
Follow the next steps to install them in a [Python virtual environment](https://docs.python.org/3/library/venv.html).

1. Create a new virtual environment:

```shell
python3 -m venv .venv
```

2. Activate the virtual environment:

```shell
source .venv/bin/activate
```

```{tip}
Remember to activate the virtual environment before every time you start working!
```

3. Install dependencies

```shell
pip install -r requirements.txt
```