compile_guide.md added

This commit is contained in:
shadlyd15 2022-05-07 22:50:19 +02:00
parent f0cf2d318f
commit 3dcce7e5b8
2 changed files with 30 additions and 30 deletions

View File

@ -44,20 +44,20 @@ Change **OVMF_DIR** directory in the makefile.
### Create Image
Add your roms here in the makefile to write it to your image. For example : test_1.nes, test_2.nes
```makefile
mcopy -i $(IMAGE).img splash.bmp ::
# Add your roms here
mcopy -i $(IMAGE).img test_1.nes ::
mcopy -i $(IMAGE).img test_2.nes ::
```
```bash
make img
```
```makefile
mcopy -i $(IMAGE).img splash.bmp ::
# Add your roms here
mcopy -i $(IMAGE).img test_1.nes ::
mcopy -i $(IMAGE).img test_2.nes ::
```
```bash
make img
```
### Run
```bash
make run
```
```bash
make run
```
# NesUEFI on real hardware
**Do at your own risk. Under no circumstances shall the author be liable for any damage.**
Technically NesUEFI should not mess with your system. But you should at least know what you are doing.
@ -73,17 +73,17 @@ Technically NesUEFI should not mess with your system. But you should at least kn
# Demo on Real Hardware
## Controls
| NesUEFI Key | Keyboard Key |
| ----------- | ----------- |
| Up | W |
| Down | S |
| Left | A |
| Right | D |
| Select | U |
| Start | I |
| A | K |
| B | J |
| Reload | R |
| NesUEFI Key | Keyboard Key |
| ----------- | ----------- |
| Up | W |
| Down | S |
| Left | A |
| Right | D |
| Select | U |
| Start | I |
| A | K |
| B | J |
| Reload | R |
## Known Issues
- Mappers are not implemented yet.
- It does not support Audio emulation yet.

View File

@ -26,26 +26,26 @@ Go to gnu-efi source folder
Use this makefile to easily compile and run gnu-efi application. It will recursively compile all c files in the sub-directories.
Change the following macros to locate the libraries and headers installed on the previous step.
```makefile
```makefile
IMAGE = uefi_app
TARGET = main.efi
INCDIR = /usr/local/include
LIBDIR = /usr/local/lib
EFILIB = /usr/local/lib
```
```
## Run on qemu :
### Locate OVMF in Makefile:
To run the compiled application in qemu we need OVMF for UEFI emulation. OVMF is a port of Intel's tianocore firmware to the qemu virtual machine. Download it from here.
```makefile
```makefile
OVMF_DIR = ../OVMF
```
```
Change the OVMF directory in the makefile.
### Create Image :
```bash
make img
```
```bash
make img
```
It will do the following tasks :
```bash
# Create a new image file that will contain the GNU-EFI application.