zenermerps/onion2s-build
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

docs: Update README for new release

Browse source
This commit is contained in:
Andreas Mieke 2024-11-21 02:25:56 -05:00
parent cd2cf79ccf
commit f63168fe0a
Signed by: zenermerps
SSH key fingerprint: SHA256:Ne+hwc5QIgYlqCuLZ0LV3301Wo/p8UoGOrGC+T6S0t8
1 changed files with 33 additions and 25 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

56
README.md
View file

@ -1,35 +1,43 @@
# onion2s-build
Docker image for cross to build rust packages for the Onion Omega 2S(+)
Docker image for cross to build Rust packages for the Onion Omega 2S(+)
## Prerequisites
You will need to have the rustup version of cargo installed, for more information look at the official Rust documentation. You need Docker (or Podman) up and running, and you need to install cross with:
```sh
cargo install cross --git https://github.com/cross-rs/cross
cargo install cross
```
## Configuration
To compile for the Onion Omega 2S(+) you need to add the following configuration:
Cargo.toml:
```toml
[workspace.metadata.cross.target.mipsel-unknown-linux-musl]
image = "git.merp.digital/zenermerps/onion2s-build:latest"
build-std = ["std"]
```
.cargo/config:
```toml
[target.mipsel-unknown-linux-musl]
linker = "/source/staging_dir/toolchain-mipsel_24kc_gcc-7.3.0_musl/bin/mipsel-openwrt-linux-musl-gcc"
```
_Note_: cargo will complain that this location is deprecated, however (at least on macOS) moving the file to the suggested location results in an error about `Cargo.toml` not being found (while a `cargo.toml` exists). I assume this is due to some discrepancy between macOS's case-insensitive vs Linux's case-sensistive file system.
## Build
You then can use `cross` as replacement for `cargo`, you need to specify the target with: `--target mipsel-unknown-linux-musl`, this is all you need to compile for the Onion Omega 2S(+).
For example:
You will also need to install the nightly toolchain of Rust for your platform:
```sh
cross build --release --target mipsel-unknown-linux-musl
rustup install nightly
```
On the first run of cross, cross will also install a nightly toolchain that is able to run in the Docker image (amd64).
### A note on ARM Macs
When trying to run cross on an ARM based Mac, docker will try to download the image for the ARM arch. Since cross doesn't provide ARM base images, this will fail. However, utilizing Rosetta, it is possible to run AMD64 images. To use those, pull the image manually using docker:
```sh
docker pull --platform linux/amd64 git.merp.digital/zenermerps/onion2s-build:latest
```
This ensures docker will find an image with the correct name and tag, and doesn't try to download the non-existing ARM version.
## Configuration
To compile for the Onion Omega 2S(+) you need to add the following configuration to your `Cargo.toml`:
```toml
[package.metadata.cross.target.mipsel-unknown-linux-musl]
image = "git.merp.digital/zenermerps/onion2s-build:latest"
build-std = true
```
## Build
You then can use `cross +nightly` as replacement for `cargo`. You need to specify the correct target with: `--target mipsel-unknown-linux-musl`, this is all you need to compile for the Onion Omega 2S(+).
For example:
```sh
cross +nightly build --release --target mipsel-unknown-linux-musl
```