Readme

Author: kirjavascript

.clang-format

@@ -5,9 +5,7 @@ members = [
 name = "z80"
 authors = ["kirjavasciprt"]
 version = "0.0.0"
-publish = false
 edition = "2021"
-autobins = false
 
 [lib]
 name = "z80"
@@ -16,3 +14,6 @@ crate-type = ["staticlib", "rlib"]
 
 [dependencies]
 c2rust-bitfields= "0.3"
+
+[profile.test]
+opt-level = 3

.github/workflows/tests_runner.yml

@@ -1,11 +1,18 @@
-# The Jolly Good Z80
+# Z80
 
-The Jolly Good Z80 is a fast and accurate instruction-stepped Z80 emulator written in C11.
+a fast and accurate instruction-stepped Z80 emulator written in C11 and ported to Rust with c2rust and manual refactoring.
 
-The emulator currently passes both zexdoc and zexall Z80 instruction tests.
-It has also been verified correct against VisualZ80.
+This emulator passes both the ZEXDOC and ZEXALL Z80 instruction tests. It has also been verified correct against VisualZ80, and is known to run the entire ColecoVision, SG-1000, Master System, and Game Gear libraries. Additionally, it has been successfully integrated into Mega Drive/Genesis and Neo Geo emulators with unknown (but likely high or perfect) compatibility.
 
-You can run the tests by running `make && ./z80_tests`, which outputs:
+## Licensing
+
+This project is under the MIT license, except the files in `roms` which are provided for convenience to test the z80 core implementation. These files authors' and licenses can be seen in the source files (.z80/.src files).
+
+This emulator is a fork of [carmiker/jgz80](https://github.com/carmiker/jgz80)
+
+## Tests
+
+You can run the tests by running `cargo test --release -- --no-capture`, which outputs:
 
 ```
 *** TEST: roms/prelim.com
@@ -157,12 +164,6 @@ Tests complete
 *** 5764169747 instructions executed on 46734978649 cycles (expected=46734978649, diff=0)
 ```
 
-## Licensing
-
-This project is under the MIT license, except the files in `roms` which are provided for convenience to test the z80 core implementation. These files authors' and licenses can be seen in the source files (.z80/.src files).
-
-This emulator is a hard fork of [superzazu/z80](https://github.com/superzazu/z80)
-
 ## Resources
 
 - [Z80 CPU User Manual](http://z80.info/zip/z80cpu_um.pdf)