Skip to content

docs: Pre-requirement cleanup, reorganize. Add ArchLinux #286

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: Pre-requirement cleanup, reorganize. Add ArchLinux #286

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 2 additions & 24 deletions docs/development/qemu.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# QEMU

```{important}
QEMU is only available for STM32 targets
QEMU is only available for STM32 targets such as the snowy_bb2
```

## Getting QEMU
Expand All @@ -11,29 +11,7 @@ Below you can also find a detailed guide on how to build it from source if you n

### Building from source

1. Install OS-level pre-requisites:

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

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

```shell
sudo apt install autoconf libglib2.0-dev libpixman-1-dev
```

::::

::::{tab-item} macOS
:sync: macos

```shell
brew install autoconf glib pixman
```

::::
:::::
1. Ensure all pre-requirements are installed from "Getting Started"

2. Install `pyenv` following [this guide](https://github.com/pyenv/pyenv?tab=readme-ov-file#installation) (steps A-D).
3. Install Python 2.7:
Expand Down
33 changes: 32 additions & 1 deletion docs/getting_started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ Follow this guide to:

## Pre-requisites

### arm-none-eabi Toolchain

First download the Arm GNU toolchain `arm-none-eabi` 14.2.Rel1 from [here](https://developer.arm.com/downloads/-/arm-gnu-toolchain-downloads).
Make sure to make it available on your path `PATH` and then check GCC version is reported correctly:

Expand All @@ -19,6 +21,8 @@ This is free software; see the source for copying conditions. There is NO
warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
```

### Build Dependencies

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

Expand All @@ -37,7 +41,18 @@ sudo apt update
2. Install required dependencies

```shell
sudo apt install clang gcc gcc-multilib git gettext python3-dev python3-venv
sudo apt install clang gcc gcc-multilib git gettext python3-dev python3-venv autoconf libglib2.0-dev libpixman-1-dev
```

::::

::::{tab-item} Arch Linux
:sync: arch

1. Install required dependencies

```shell
sudo pacman -Sy autotools clang gcc gcc-multilib git gettext python3 autoconf pixman
```

::::
Expand All @@ -53,6 +68,12 @@ sudo apt install clang gcc gcc-multilib git gettext python3-dev python3-venv
brew link python@3
```

3. Install required dependencies

```shell
brew install autoconf glib pixman
```

::::

:::::
Expand All @@ -71,6 +92,16 @@ If building with Javascript support enabled (default), install Emscripten:
It is recommended to follow them.
::::

::::{tab-item} Arch Linux
:sync: arch

1. Install enscripten

```shell
sudo pacman -Sy emscripten
```
::::

::::{tab-item} macOS
:sync: macos

Expand Down