Skip to content

Commit

Permalink
Separate building instructions from the main README file
Browse files Browse the repository at this point in the history
This is done both for aesthetics and clarity.

A separate building document allows for specifying platform-specific
instructions. It also allows the documnet to be more clear-cut.
  • Loading branch information
slendidev committed Apr 2, 2022
1 parent 8a682fb commit 8da48ae
Show file tree
Hide file tree
Showing 2 changed files with 61 additions and 10 deletions.
60 changes: 60 additions & 0 deletions BUILDING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
# Building

This document assumes that you are using a GNU/Linux enviroment. If you are running on Windows, WSL or a VM should work.

## Prerequisites

### Fedora

```
sudo dnf install texinfo binutils-devel curl cmake mpfr-devel libmpc-devel gmp-devel patch @"C Development Tools and Libraries" git
```

### openSUSE

```
sudo zypper install curl cmake mpfr-devel mpc-devel gmp-devel patch gcc gcc-c++ patterns-devel-C-C++-devel_C_C++ git
```

### Void Linux

```
sudo xbps-install -S base-devel cmake curl mpfr-devel libmpc-devel gmp-devel git
```

### ALT Linux

```
apt-get install curl cmake libmpc-devel gmp-devel libmpfr-devel patch git
```

## Cloning the repository

```
git clone --depth 1 --recurse-submodules --shallow-submodules https://github.com/xslendix/yros.git
cd yros
```

Since this project uses buildroot as a submodule, `--recurse-submodules` is required. The repositories are also shallow cloned so it doesn't take too much time just to get everything downloaded.

## Starting a build

### With GUI:
```
make rpi3_64-gui
# OR
make rpi4_64-gui
```

### Without GUI (headless) (not yet available):
```
make rpi3_64-nogui
# OR
make rpi4_64-nogui
```

A typical build on my machine takes ~2 hours. Of course, for you it may take longer or less, so be sure to have something to do while you're waiting.

## Flashing the image

The output image file can be found at `buildroot/output/images.img`.
11 changes: 1 addition & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,4 @@ This project utilizes [Buildroot](https://buildroot.org/) to create a fast, port

## Building

```
make rpi3_64-gui
# OR
make rpi4_64-gui
```

## Known bugs

* rpi4 build includes the rpi3 config.txt file. The file needs to be manually replaced after each flashed.

For build instructions please check out [BUILDING.md](/BUILDING.md).

0 comments on commit 8da48ae

Please sign in to comment.