Skip to content

Commit

Permalink
touch up readme
Browse files Browse the repository at this point in the history
  • Loading branch information
metavee committed Jul 30, 2024
1 parent a4d0630 commit 9307e3e
Showing 1 changed file with 8 additions and 4 deletions.
12 changes: 8 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,11 @@ puzdug x86 is a tiny game written in 16-bit real-mode x86 assembly.
It is written such that it can be booted from a floppy on a BIOS-based computer.
Although it does not fit entirely in the boot sector, it comes with a bootloader that will load the game from a known location on disk and boot into that.

## Setup
## Downloads

Tagged commits are accompanied with a Github Release with the DOS-compatible `puzdug.com` and the bootable floppy image `puzdug-boot.img` attached.

## Developer Setup

Install the following tools:

Expand All @@ -23,13 +27,13 @@ And optionally:

## Running in DOSBox

Build with `just build-dos`.
Build with `just build-dos` or download the pre-built binary from the Releases page.

Open up DOSBox, mount the repo folder in (you may wish to set up a startup script), and run `PUZDUG.COM` or just `PUZDUG`.

## Running in qemu
## Running in qemu or a virtual machine

Build and run with `just qemu`. This creates the floppy image `puzdug-boot.bin`.
Build and run with `just qemu`. This creates the floppy image `puzdug-boot.bin`. You can also download the pre-built image from the Releases page.

Note that when the game exits, it enters an infinite loop and you need to kill qemu to fully stop it.

Expand Down

0 comments on commit 9307e3e

Please sign in to comment.