fox32/README.md

29 lines
1.4 KiB
Markdown
Raw Normal View History

2022-01-31 12:11:08 +01:00
# fox32
2022-06-22 00:56:29 +02:00
![fox32 logo](docs/logos/fox32.png)
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-08-13 04:34:41 +02:00
![Screenshot of fox32os](docs/screenshots/screenshot_launcher.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).
Prebuilt binaries of the latest commit are also available on the [GitHub Actions page](https://github.com/fox32-arch/fox32/actions).
### Building
Download the latest release of [**fox32rom**](https://github.com/fox32-arch/fox32rom/releases), and place the downloaded `fox32.rom` file into the `src` directory. Then simply run `cargo build --release`. The resulting binary will be saved as `target/release/fox32`. You can also run `cargo run --release` if you want to run it directly.
2022-01-31 12:11:08 +01:00
### Usage
Passing files as arguments will mount those files as disks, in the order that the arguments were passed. The most common use case is passing the [**fox32os**](https://github.com/fox32-arch/fox32os) disk image as the first argument: `fox32 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).