Bizmuth - ZX Spectrum Next emulator
https://bizmuth.twistedraven.net

Bizmuth is a cycle-accurate ZX Spectrum Next emulator and developer tool. It
implements the DZRP protocol so the DeZog VS Code extension can connect for
source-level debugging, the same way CSpect is used by Next developers.

The executable is named "bizmuth". "Azimuth" is the project codename; "Bizmuth"
is the application name.


PACKAGES (built by the scripts in this directory)
--------------------------------------------------
  build-deb.sh       -> dist/bizmuth_<version>_<arch>.deb
                        Debian/Ubuntu package. Installs /usr/bin/bizmuth, a
                        desktop launcher, and icons. GTK3/SDL2/ALSA/libnotify
                        are declared as dependencies (apt pulls them in).

  build-appimage.sh  -> dist/Bizmuth-<version>-<arch>.AppImage
                        Portable single file for any modern Linux: it BUNDLES
                        the GTK3 stack, so it needs nothing installed. Just
                        `chmod +x` it and run.

  build-arch.sh      -> dist/bizmuth-<version>-<rel>-<arch>.pkg.tar.zst
                        Native Arch/CachyOS package (wraps makepkg + PKGBUILD).
                        gtk3/sdl2/alsa-lib/libnotify are real pacman deps.
                        Pass -i to build AND install. Built with -C
                        target-cpu=native (per the host makepkg.conf).

The .deb and AppImage scripts build the release binary first (pass --skip-build
to reuse an existing target/release/bizmuth). They need Rust/cargo; the AppImage
script also needs curl/wget (to fetch linuxdeploy on first run) and the GTK3
stack on the build host. build-arch.sh needs an Arch-family host (makepkg) and
does its own isolated cargo build under dist/. See the header comment in each
script for options.


ROMs ARE NOT INCLUDED
---------------------
Bizmuth ships no ZX Spectrum / Spectrum Next ROMs or SD-card images - those are
copyrighted and must be obtained separately.

Required files, by machine:
  Spectrum Next (default) : tbblue_loader.rom   plus a Next SD-card image
  Spectrum 48K            : 48.rom
  Spectrum 128K           : 128-0.rom, 128-1.rom
  Spectrum +2A / +3       : plus3-0.rom, plus3-1.rom, plus3-2.rom, plus3-3.rom

Point Bizmuth at the folder holding them the first time:

    bizmuth --roms-dir ~/Spectrum/roms

The path is remembered in the config afterwards, so later launches (including
from the applications menu) need no arguments. Alternatively, run bizmuth from a
directory that has a "roms" subfolder - it searches upward from the working
directory for one.


RUNNING
-------
Launch "Bizmuth" from the applications menu, or run bizmuth directly.
For command-line options:  bizmuth --help

See https://bizmuth.twistedraven.net for documentation and updates.
