fox32/README.md

35 lines
1.7 KiB
Markdown
Raw Normal View History

2022-01-31 12:11:08 +01:00
# fox32
2022-12-29 06:24:04 +01:00
![fox32 logo](docs/logos/fox32-circle.png)
(logo by [ZenithNeko](https://zencorner.xyz/contacts.html))
2022-06-22 00:56:29 +02:00
2022-01-31 12:11:08 +01:00
**fox32** (stylized in all lowercase) is a 32 bit fantasy computer architecture, with a custom operating system and user interface inspired by various classic computers.
2022-10-27 03:21:15 +02:00
![Screenshot of fox32os](docs/screenshots/fox32os-terminal.png)
2022-06-22 00:56:29 +02:00
2022-01-31 12:11:08 +01:00
## Getting Started
**Note: This software is still very much in an early stage, and is currently more focused towards developers rather than end-users.**
Stable releases are available on the [Releases page](https://github.com/fox32-arch/fox32/releases).
2022-10-27 03:21:15 +02:00
Prebuilt Linux binaries of the latest commit are also available on the [GitHub Actions page](https://github.com/fox32-arch/fox32/actions).
### Building
2023-02-22 09:59:59 +01:00
Download the latest release or commit of [**fox32rom**](https://github.com/fox32-arch/fox32rom), and place the downloaded `fox32.rom` file into the root directory of this repo. Then simply run `make`. The resulting binary will be saved as `fox32`. Optionally you may build for a different target with `make TARGET=<target>`, see the Makefile for details.
2022-01-31 12:11:08 +01:00
### Usage
2022-10-28 00:30:50 +02:00
The following arguments are valid:
- `--disk <file>`: mount the specified file as a disk
- `--rom <file>`: use the specified file as the boot ROM. if this argument is not specified then the embedded copy of **fox32rom** is used
- `--debug`: print a disassembly of each instruction as it runs
The most common use case is passing the [**fox32os**](https://github.com/fox32-arch/fox32os) disk image as the first disk: `./fox32 --disk fox32os.img`
2022-07-05 06:36:07 +02:00
See [encoding.md](docs/encoding.md) for information about the instruction set.
2022-01-31 12:11:08 +01:00
## License
2022-06-22 00:56:29 +02:00
This project is licensed under the [MIT license](LICENSE).