Skip to content
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.

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

update quickstart/building commands #206

Merged
merged 1 commit into from
Sep 26, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
16 changes: 7 additions & 9 deletions building/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,9 +38,8 @@ be, install git:
<summary>Installing git on Ubuntu (click to expand)</summary>

```console
sudo apt-get update && \
sudo apt-get upgrade && \
sudo apt-get install git
sudo apt update && \
sudo apt install -y git
```

</details>
Expand Down Expand Up @@ -74,7 +73,6 @@ be, install git:

```console
brew update && \
brew upgrade && \
brew install git
```

Expand Down Expand Up @@ -127,8 +125,8 @@ Firstly, you need to have the docker installed.
- Install required packages

```console
sudo apt-get update && \
sudo apt-get install curl \
sudo apt update && \
sudo apt install -y curl \
ca-certificates \
gnupg \
lsb-release
Expand Down Expand Up @@ -265,11 +263,11 @@ There is a list of commands you can use to get them: on both Ubuntu and macOS ho
<summary>Intalling required tools for native build on Ubuntu (click to expand)</summary>

```console
sudo apt-get update && \
sudo apt-get upgrade && \
sudo apt-get install build-essential \
sudo apt update && \
sudo apt install -y build-essential \
mtd-utils \
autoconf \
pkg-config \
texinfo \
genext2fs \
libtool \
Expand Down
30 changes: 15 additions & 15 deletions quickstart/armv7m4-stm32l4x6-nucleo.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,8 +66,8 @@ To communicate with the board you will need to use a UART-USB converter, like `P
<summary>How to get picocom and run it without privileges (Ubuntu 22.04)</summary>

```console
sudo apt-get update && \
sudo apt-get install picocom
sudo apt update && \
sudo apt install -y picocom
```

To use picocom without sudo privileges run this command and then restart:
Expand Down Expand Up @@ -99,14 +99,14 @@ openocd -v
```

<details>
<summary>How to get openocd in version 0.11 (Ubuntu 22.04)</summary>
<summary>How to get openocd on Ubuntu</summary>

To install from the default repositoriy:

- use `apt-get`
- use `apt`

```console
sudo apt-get install openocd
sudo apt install -y openocd
```

- check if the version is correct
Expand All @@ -115,19 +115,19 @@ To install from the default repositoriy:
openocd -v
```

To install manually:
If you encounter errors install manually from sources (v0.12.0):

- download `openocd-0.11.0-rc2` from [here](https://launchpad.net/ubuntu/+source/openocd)
- enter the downloaded directory
- download, build and install `openocd-0.12.0-1` from sources

```console
cd openocd-0.11.0-rc2
```

- install openocd

```console
sudo apt-get install libusb-1.0 && ./configure --enable-stlink && make && sudo make install
wget -O- https://launchpad.net/ubuntu/+archive/primary/+sourcefiles/openocd/0.12.0-1build2/openocd_0.12.0.orig.tar.bz2 | \
sudo tar xjvf - -C /usr/local/src && \
cd /usr/local/src/openocd-0.12.0 && \
sudo apt install -y pkg-config \
libusb-1.0-0-dev && \
./configure --enable-stlink && \
make && \
sudo make install
```

- check if the version is correct
Expand Down
16 changes: 9 additions & 7 deletions quickstart/ia32-generic-qemu.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,14 +16,16 @@ Firstly, you need to install QEMU emulator.
- Install the required packages

```console
sudo apt-get update && \
adamdebek marked this conversation as resolved.
Show resolved Hide resolved
sudo apt-get install qemu-kvm \
qemu virt-manager \
virt-viewer libvirt-clients \
sudo apt update && \
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am not sure about removing qemu-system-misc, it's probably needed for riscv and if someone installed qemu in ia32-quickstart they can assume that it's already properly installed.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

qemu-system-misc is already provided by qemu-system package

sudo apt install -y \
qemu-system \
virt-manager \
virt-viewer \
libvirt-clients \
libvirt-daemon-system \
bridge-utils virtinst \
libvirt-daemon \
qemu-system-misc
bridge-utils \
virtinst \
libvirt-daemon
```

- Check if QEMU is properly installed:
Expand Down
16 changes: 9 additions & 7 deletions quickstart/riscv64-generic-qemu.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,14 +17,16 @@ Firstly, you need to install QEMU emulator.
- Install the required packages

```console
sudo apt-get update && \
sudo apt-get install qemu-kvm \
qemu virt-manager \
virt-viewer libvirt-clients \
sudo apt update && \
sudo apt install -y \
qemu-system \
virt-manager \
virt-viewer \
libvirt-clients \
libvirt-daemon-system \
bridge-utils virtinst \
libvirt-daemon \
qemu-system-misc
bridge-utils \
virtinst \
libvirt-daemon
```

- Check if QEMU is properly installed:
Expand Down
Loading