fox32/README.md

29 lines
1.2 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-06-22 00:56:29 +02:00
![Screenshot of fox32rom](docs/screenshots/screenshot_fox32rom.png)
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.**
### Building
Clone this repository, `cd` into it, then clone the [fox32core](https://github.com/fox32-arch/fox32core) repository in a folder called `fox32core`.
After that, just run `cargo build --release`. The resulting binary will be saved as `target/release/fox32`
2022-01-31 12:11:08 +01:00
### Usage
**fox32** attempts to read its ROM from a file called `fox32.rom` in the current directory. If this file isn't found then it falls back to `../fox32rom/fox32.rom`, and if this file isn't found then it exits.
Passing files as arguments will mount those files as disks, in the order that the arguments were passed.
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).