From 29d6690d9708440b61f0d2ae378e8648100d4a18 Mon Sep 17 00:00:00 2001 From: ry755 Date: Mon, 31 Jan 2022 03:11:08 -0800 Subject: [PATCH] Add unfinished READMEs --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..33dcc35 --- /dev/null +++ b/README.md @@ -0,0 +1,16 @@ +# fox32 + +**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. + +## Getting Started + +**Note: This software is still very much in an early stage, and is currently more focused towards developers rather than end-users.** + +### 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. + +See [encoding.md](encoding.md) for information about the instruction set. + +## License +This project is licensed under the [MIT license](LICENSE). \ No newline at end of file