Skip to content

Commit eb89623

Browse files
committed
docs: Pre-requirement cleanup, reorganize. Add ArchLinux
1 parent 57e9f49 commit eb89623

File tree

2 files changed

+61
-25
lines changed

2 files changed

+61
-25
lines changed

docs/development/qemu.md

Lines changed: 2 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# QEMU
22

33
```{important}
4-
QEMU is only available for STM32 targets
4+
QEMU is only available for STM32 targets such as the snowy_bb2
55
```
66

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

1212
### Building from source
1313

14-
1. Install OS-level pre-requisites:
15-
16-
:::::{tab-set}
17-
:sync-group: os
18-
19-
::::{tab-item} Ubuntu 24.04 LTS
20-
:sync: ubuntu
21-
22-
```shell
23-
sudo apt install autoconf libglib2.0-dev libpixman-1-dev
24-
```
25-
26-
::::
27-
28-
::::{tab-item} macOS
29-
:sync: macos
30-
31-
```shell
32-
brew install autoconf glib pixman
33-
```
34-
35-
::::
36-
:::::
14+
1. Ensure all pre-requirements are installed from "Getting Started"
3715

3816
2. Install `pyenv` following [this guide](https://github.com/pyenv/pyenv?tab=readme-ov-file#installation) (steps A-D).
3917
3. Install Python 2.7:

docs/getting_started.md

Lines changed: 59 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,14 @@ Follow this guide to:
88

99
## Pre-requisites
1010

11+
### arm-none-eabi toolchain
12+
13+
:::::{tab-set}
14+
:sync-group: toolchain
15+
16+
::::{tab-item} Binary Toolchain (recommended)
17+
:sync: official
18+
1119
First download the Arm GNU toolchain `arm-none-eabi` 14.2.Rel1 from [here](https://developer.arm.com/downloads/-/arm-gnu-toolchain-downloads).
1220
Make sure to make it available on your path `PATH` and then check GCC version is reported correctly:
1321

@@ -19,6 +27,29 @@ This is free software; see the source for copying conditions. There is NO
1927
warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
2028
```
2129

30+
::::
31+
32+
::::{tab-item} Arch Linux
33+
:sync: arch
34+
35+
```shell
36+
sudo pacman -Sy arm-none-eabi-gcc arm-none-eabi-binutils arm-none-eabi-gdbarm-none-eabi-newlib
37+
```
38+
39+
```shell
40+
$ arm-none-eabi-gcc --version
41+
arm-none-eabi-gcc (Arch Repository) 14.2.0
42+
Copyright (C) 2024 Free Software Foundation, Inc.
43+
This is free software; see the source for copying conditions. There is NO
44+
warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
45+
```
46+
47+
::::
48+
:::::
49+
50+
51+
### Build Dependencies
52+
2253
A series of system-level dependencies are required.
2354
Follow the next steps to install them.
2455

@@ -37,7 +68,18 @@ sudo apt update
3768
2. Install required dependencies
3869

3970
```shell
40-
sudo apt install clang gcc gcc-multilib git gettext python3-dev python3-venv
71+
sudo apt install clang gcc gcc-multilib git gettext python3-dev python3-venv autoconf libglib2.0-dev libpixman-1-dev
72+
```
73+
74+
::::
75+
76+
::::{tab-item} Arch Linux
77+
:sync: arch
78+
79+
1. Install required dependencies
80+
81+
```shell
82+
sudo pacman -Sy autotools clang gcc gcc-multilib git gettext python3 autoconf pixman
4183
```
4284

4385
::::
@@ -53,6 +95,12 @@ sudo apt install clang gcc gcc-multilib git gettext python3-dev python3-venv
5395
brew link python@3
5496
```
5597

98+
3. Install required dependencies
99+
100+
```shell
101+
brew install autoconf glib pixman
102+
```
103+
56104
::::
57105

58106
:::::
@@ -71,6 +119,16 @@ If building with Javascript support enabled (default), install Emscripten:
71119
It is recommended to follow them.
72120
::::
73121

122+
::::{tab-item} Arch Linux
123+
:sync: arch
124+
125+
1. Install enscripten
126+
127+
```shell
128+
sudo pacman -Sy emscripten
129+
```
130+
::::
131+
74132
::::{tab-item} macOS
75133
:sync: macos
76134

0 commit comments

Comments
 (0)