Skip to content

Commit a209861

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

File tree

2 files changed

+34
-25
lines changed

2 files changed

+34
-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: 32 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ Follow this guide to:
88

99
## Pre-requisites
1010

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

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

24+
### Build Dependencies
25+
2226
A series of system-level dependencies are required.
2327
Follow the next steps to install them.
2428

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

3943
```shell
40-
sudo apt install clang gcc gcc-multilib git gettext python3-dev python3-venv
44+
sudo apt install clang gcc gcc-multilib git gettext python3-dev python3-venv autoconf libglib2.0-dev libpixman-1-dev
45+
```
46+
47+
::::
48+
49+
::::{tab-item} Arch Linux
50+
:sync: arch
51+
52+
1. Install required dependencies
53+
54+
```shell
55+
sudo pacman -Sy autotools clang gcc gcc-multilib git gettext python3 autoconf pixman
4156
```
4257

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

71+
3. Install required dependencies
72+
73+
```shell
74+
brew install autoconf glib pixman
75+
```
76+
5677
::::
5778

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

95+
::::{tab-item} Arch Linux
96+
:sync: arch
97+
98+
1. Install enscripten
99+
100+
```shell
101+
sudo pacman -Sy emscripten
102+
```
103+
::::
104+
74105
::::{tab-item} macOS
75106
:sync: macos
76107

0 commit comments

Comments
 (0)