Skip to content

Commit e97d41f

Browse files
committed
README.md: Structure and format better. Add make emulaterom.
1 parent 1eea613 commit e97d41f

File tree

1 file changed

+24
-18
lines changed

1 file changed

+24
-18
lines changed

README.md

+24-18
Original file line numberDiff line numberDiff line change
@@ -2,39 +2,45 @@
22

33
Booted from a floppy, it will load an Option ROM image into the end of conventional memory.
44

5-
![PCem PC1512 screenshot](https://b.rvalles.net/unsorted/pcem_pc1512_optromboot_xtide.png)
5+
![PCem IBM XT screenshot](https://b.rvalles.net/unsorted/pcem_ibmxt_optromboot_xtide.png)
66

7-
Usage
8-
* Ensure fasm (flat assembler) is installed
9-
* Copy your ROM image as the `optrom.bin` file.
10-
* Run `make`.
11-
* Optionally test with qemu: `make emulate`.
12-
* Floppy images will be created (fd*.img).
13-
* Alternatively, use a binary release. Concatenate:
14-
* optromloader9/15/18 (according to sectors per track in your floppy format)
15-
* 9 for 5.25" 360K and 3.5" 720K
16-
* 15 for 5.25" 1.2M
17-
* 18 for 3.5" 1.44M
18-
* the ROM image.
19-
* pad to floppy size.
20-
21-
Use cases (non-exhaustive)
7+
## Use cases (non-exhaustive)
228
* Test boot ROMs before burning them.
239
* Netboot with etherboot/gpxe/ipxe.
2410
* IDE support (including LBA!) with XTIDE Universal BIOS.
2511

26-
Highlights
12+
## Highlights
2713
* flat assembler syntax.
2814
* Pure 8086 code.
2915
* Works on newer hardware, such as the 486 I wrote it for.
3016
* Fits in a floppy bootblock.
3117
* Trivial to use. Concatenate loader and the ROM image, write into floppy.
3218
* Makefile will prepare 5.25" 360K/1.2M and 3.5" 720K/1.44M floppy images.
19+
* MIT License. See LICENSE file.
3320

34-
Caveats
21+
## Usage
22+
* Ensure fasm (flat assembler) is installed.
23+
* Copy your ROM image as the `optrom.bin` file.
24+
* Optionally test ROM image with qemu: `make emulaterom`.
25+
* Run `make`.
26+
* Floppy images will be created (fd*.img).
27+
* Optionally test 1.44M image with qemu: `make emulate`.
28+
* Alternatively, use a binary release. Concatenate:
29+
* optromloader9/15/18 (according to sectors per track in your floppy format).
30+
* 9 for 5.25" 360K and 3.5" 720K.
31+
* 15 for 5.25" 1.2M.
32+
* 18 for 3.5" 1.44M.
33+
* the ROM image.
34+
* pad to floppy size.
35+
36+
## Caveats
3537
* Hardcoded to use the first floppy drive.
3638
* ROM checksum isn't checked (yet).
3739
* Always ensure a boot ROM is signed before burning.
40+
* Test with `make emulaterom`. Qemu's BIOS won't see the ROM if it's not signed.
3841
* Qemu provides a python tool to sign ROMs:
3942
* https://github.com/qemu/qemu/blob/master/scripts/signrom.py
4043
* For XTIDE Universal BIOS roms, use its XTIDECFG tool to configure and sign ROM images.
44+
45+
## Author
46+
Roc Vallès Domènech

0 commit comments

Comments
 (0)