From e1676cffeca72d537546de876effcceab717e32b Mon Sep 17 00:00:00 2001 From: probonopd Date: Tue, 19 Apr 2022 12:06:16 +0200 Subject: [PATCH] Move "Building" to wiki [ci skip] --- README.md | 74 +++---------------------------------------------------- 1 file changed, 4 insertions(+), 70 deletions(-) diff --git a/README.md b/README.md index be58f3b..33a9d39 100644 --- a/README.md +++ b/README.md @@ -91,81 +91,15 @@ __CAUTION:__ All GPIO numbers are [chip numbers](https://pinout.xyz/), not heade Compiled versions are available on [GitHub Releases](../../releases). Just download and put on a FAT32 formatted SD card. -## Building locally - -Normal users do not need to build the source code, as compiled versions are provided for download (see above). If you are a developer and want to build the source code yourself, you can use the following example, e.g., to build for Raspberry Pi 4 on a Ubuntu 20.04 build system. See [`build.yml`](../../tree/main/.github/workflows/build.yml) for complete build steps that create versions for Raspberry Pi 1, 2, 3,and 4 in 32-bit and 64-bit as required. - -``` -# Choose your RPi -export RPI=4 - -git clone https://github.com/probonopd/MiniDexed -cd MiniDexed -mkdir -p kernels sdcard - -# Recursively pull git submodules -git submodule update --init --recursive - -# Install toolchain -if [ "${RPI}" -gt 2 ] -then - wget https://developer.arm.com/-/media/Files/downloads/gnu-a/10.3-2021.07/binrel/gcc-arm-10.3-2021.07-x86_64-aarch64-none-elf.tar.xz -else - wget https://developer.arm.com/-/media/Files/downloads/gnu-a/10.3-2021.07/binrel/gcc-arm-10.3-2021.07-x86_64-arm-none-eabi.tar.xz -fi -tar xvf gcc-arm-*-*.tar.xz -export PATH=$(readlink -f ./gcc-*/bin/):$PATH - -# Build dependencies and MiniDexed -./build.sh -cp ./src/kernel*.img ./kernels/ - -# Get Raspberry Pi boot files -cd ./circle-stdlib/libs/circle/boot -make -if [ "${RPI}" -gt 2 ] -then - make armstub64 -fi -cd - - -# Make zip that contains Raspberry Pi 4 boot files. The contents can be copied to a FAT32 formatted partition on a microSD card -cd sdcard -../getsysex.sh -cd .. -cp -r ./circle-stdlib/libs/circle/boot/* sdcard -rm -rf sdcard/config*.txt sdcard/README sdcard/Makefile sdcard/armstub sdcard/COPYING.linux -cp ./src/config.txt ./src/minidexed.ini ./src/*img ./src/performance.ini sdcard/ -echo "usbspeed=full" > sdcard/cmdline.txt -cd sdcard -cp ../kernels/* . || true -zip -r ../MiniDexed_$GITHUB_RUN_NUMBER_$(date +%Y-%m-%d).zip * -cd - - -# Optionally, create a RPi image. This can be written to a microSD card using tools like Etcher or dd -sudo apt install --yes mount parted -IMG="`date +%Y-%m-%d`_minidexed-RPi${RPI}.img" -dd of="${IMG}" seek=50MiB bs=1 count=0 -sudo parted "${IMG}" mktable msdos -sudo parted "${IMG}" mkpart primary fat32 2048s 100% -DEV=`sudo losetup --find --partscan --show "${IMG}"` -sudo mkfs.vfat -F 32 -n BOOT "${DEV}p1" -mkdir boot -sudo mount "${DEV}p1" boot -sudo cp -R sdcard/* boot -sudo umount boot -sudo losetup -d "${DEV}" -rm -r boot - -# Write to SD card -sudo dd if="${IMG}" of=/dev/mmcblk0 bs=512k status=progress && sync -``` +# Building + +Please see the [wiki](https://github.com/probonopd/MiniDexed/wiki/Development#building-locally) on how to compile the code yourself. ## Discussions https://github.com/probonopd/MiniDexed/discussions -## Wiki +## Documentation https://github.com/probonopd/MiniDexed/wiki