diff --git a/README.md b/README.md index 357b1d9..073d723 100644 --- a/README.md +++ b/README.md @@ -14,28 +14,46 @@ cd .. ## How to use -### On VM +### Download release -run ```./test.sh # only works on AMD64``` to run in VM using QEMU +#### On Real hardware -### On Real hardware +if your have amd64(x86_64) UEFI computer +Download release and copy the bootx64.efi to /EFI/BOOT/bootx64.efi case independent + +#### On VM + +run: +you will need OVMF firmware you can get it [here](https://qemu.weilnetz.de/test/ovmf/usr/share/OVMF/OVMF_CODE_4M.fd) +```bash +qemu-system-x86_64 -machine type=q35,accel=kvm -drive if=pflash,format=raw,readonly=on,file="$OVMF_CODE_PATH" -hda fat:rw:build -boot order=c -smp 4 -s -serial mon:stdio +``` + +### Build + +#### On VM + +you will need OVMF firmware you can get it [here](https://qemu.weilnetz.de/test/ovmf/usr/share/OVMF/OVMF_CODE_4M.fd) +run ```./test.sh $OVMF_CODE_PATH# only works on AMD64``` to run in VM using QEMU + +#### On Real hardware copy ```edk2/Build/UEFI_fireworks/DEBUG_GCC5//UEFI_fireworks.efi``` to FAT32 or FAT16 USB at location: -| Architecture | Default Boot Path | -|--------------|-------------------| -| **x86_64 (AMD64)** | `\EFI\BOOT\BOOTX64.EFI` | -| **x86 (IA32)** | `\EFI\BOOT\BOOTIA32.EFI` | -| **ARM64 (AArch64)** | `\EFI\BOOT\BOOTAA64.EFI` | -| **ARM (32-bit)** | `\EFI\BOOT\BOOTARM.EFI` | +| Architecture | Default Boot Path | +| ------------------- | ------------------------ | +| **x86_64 (AMD64)** | `/EFI/BOOT/BOOTX64.EFI` | +| **x86 (IA32)** | `/EFI/BOOT/BOOTIA32.EFI` | +| **ARM64 (AArch64)** | `/EFI/BOOT/BOOTAA64.EFI` | +| **ARM (32-bit)** | `/EFI/BOOT/BOOTARM.EFI` | ## Controling -| Key | Action | Note | -|-----|--------|------| -| ARROW_UP | speed up | delays under 1ms may be unrelayable | -| ARROW_DOWN | slow down | max delay is about UINT32_MAXμs | -| PAGE_UP | speed up | 10x step | -| PAGE_DOWN | speed down | 10x step | -| Home key | reset speed | reset frame delay to 10ms | -| Delete key | clear screen | | +| Key | Action | Note | +| ---------- | ------------ | ----------------------------------- | +| ARROW_UP | speed up | delays under 1ms may be unrelayable | +| ARROW_DOWN | slow down | max delay is about UINT32_MAXμs | +| PAGE_UP | speed up | 10x step | +| PAGE_DOWN | speed down | 10x step | +| Home key | reset speed | reset frame delay to 10ms | +| Delete key | clear screen | | diff --git a/build.sh b/build.sh index 4e0e42d..ec782a6 100755 --- a/build.sh +++ b/build.sh @@ -9,9 +9,9 @@ else fi mkdir -p build/EFI/BOOT/ if [ "$1" == "debug" ]; then -cp edk2/Build/UEFI_fireworks/DEBUG_GCC5/X64/UEFI_fireworks.efi build/ -cp edk2/Build/UEFI_fireworks/DEBUG_GCC5/X64/UEFI_fireworks.efi build/EFI/BOOT/BOOTX64.EFI +cp $(find edk2/Build/UEFI_fireworks/DEBUG_GCC5/ -name "UEFI_fireworks.efi" -type f | head -1) build/ +cp $(find edk2/Build/UEFI_fireworks/DEBUG_GCC5/ -name "UEFI_fireworks.efi" -type f | head -1) build/EFI/BOOT/BOOTX64.EFI else -cp edk2/Build/UEFI_fireworks/RELEASE_GCC5/X64/UEFI_fireworks.efi build/ -cp edk2/Build/UEFI_fireworks/RELEASE_GCC5/X64/UEFI_fireworks.efi build/EFI/BOOT/BOOTX64.EFI +cp $(find edk2/Build/UEFI_fireworks/RELEASE_GCC5/ -name "UEFI_fireworks.efi" -type f | head -1) build/ +cp $(find edk2/Build/UEFI_fireworks/RELEASE_GCC5/ -name "UEFI_fireworks.efi" -type f | head -1) build/EFI/BOOT/BOOTX64.EFI fi \ No newline at end of file