Documentation typo 2

This commit is contained in:
baltdev 2024-04-02 00:11:24 -05:00
parent 9a843bcfca
commit e3e8e89b47
2 changed files with 10 additions and 10 deletions

View File

@ -3,7 +3,7 @@ name = "r6502"
version = "1.0.5" version = "1.0.5"
authors = ["baltdev"] authors = ["baltdev"]
edition = "2021" edition = "2021"
description = "A simple NMOS 6502 emulator." description = "A simple MOS 6502 emulator."
license = "Apache-2.0 OR MIT" license = "Apache-2.0 OR MIT"
documentation = "https://docs.rs/r6502" documentation = "https://docs.rs/r6502"
repository = "https://github.com/balt-dev/r6502/" repository = "https://github.com/balt-dev/r6502/"

View File

@ -8,7 +8,7 @@
![Maintenance](https://img.shields.io/maintenance/as-is/2024?color=gold) ![Maintenance](https://img.shields.io/maintenance/as-is/2024?color=gold)
# r6502 # r6502
### Yet another NMOS 6502 emulator. ### Yet another MOS 6502 emulator.
--- ---
@ -20,13 +20,13 @@ instead having you step the emulator one opcode at a time and handle them yourse
## Feature Flags ## Feature Flags
The following feature flags exist: The following feature flags exist:
| Name | Description | | Name | Description |
|-----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| |-----------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| bcd | Enable binary-coded decimal arithmetic.<br/>Enabled by default. Disable if you're writing a NES emulator.<br/>Note that invalid BCD is left untested and will not function faithfully to the NMOS 6502. | | bcd | Enable binary-coded decimal arithmetic.<br/>Enabled by default. Disable if you're writing a NES emulator.<br/>Note that invalid BCD is left untested and will not function faithfully to the MOS 6502. |
| bytemuck | Enables [bytemuck](https://docs.rs/bytemuck/) support. | | bytemuck | Enables [bytemuck](https://docs.rs/bytemuck/) support. |
| arbitrary | Enables [arbitrary](https://docs.rs/arbitrary/) support. This will pull in `std`. | | arbitrary | Enables [arbitrary](https://docs.rs/arbitrary/) support. This will pull in `std`. |
| serde | Enables [serde](https://docs.rs/serde) support. | | serde | Enables [serde](https://docs.rs/serde) support. |
| hashbrown | Enables [hashbrown](https://docs.rs/hashbrown) support. | | hashbrown | Enables [hashbrown](https://docs.rs/hashbrown) support. |
## Example ## Example
```rust ignore ```rust ignore
@ -54,7 +54,7 @@ fn main() {
loop { loop {
let interrupt_requested = emu.step() let interrupt_requested = emu.step()
.expect("found an invalid opcode (only NMOS 6502 opcodes are supported)"); .expect("found an invalid opcode (only MOS 6502 opcodes are supported)");
if interrupt_requested { // Go to IRQ interrupt vector if interrupt_requested { // Go to IRQ interrupt vector
let vector = u16::from_le_bytes([ let vector = u16::from_le_bytes([
emu.read(0xFFFE), emu.read(0xFFFE),