Apple-1-Tools
/
r6502
mirror of https://github.com/balt-dev/r6502.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add maintenance badge

This commit is contained in:
baltdev 2024-04-01 23:31:50 -05:00
parent 55f524d73e
commit 7f40ffc5ee
3 changed files with 20 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
.idea/vcs.xml Normal file
View File

@ -0,0 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<project version="4">
<component name="VcsDirectoryMappings">
<mapping directory="$PROJECT_DIR$" vcs="Git" />
</component>
</project>

7
Cargo.toml
View File

@ -1,12 +1,15 @@
[package]
name = "r6502"
version = "0.1.0"
version = "1.0.0"
authors = ["baltdev"]
edition = "2021"
description = "A simple NMOS 6502 emulator."
license = "Apache-2.0 OR MIT"
documentation = "https://docs.rs/r6502"
repository = ""
repository = "https://github.com/balt-dev/r6502/"
rust-version = "1.66.1"
categories = ["no-std", "no-std::no-alloc", "emulators"]
readme = "README.md"
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

17
README.md
View File

@ -5,13 +5,14 @@
[![Latest version](https://img.shields.io/crates/v/r6502.svg)](https://crates.io/crates/r6502)
[![License](https://img.shields.io/crates/l/r6502.svg)](https://github.com/balt-dev/r6502/blob/master/LICENSE-MIT)
[![unsafe forbidden](https://img.shields.io/badge/unsafe-forbidden-success.svg)](https://github.com/rust-secure-code/safety-dance/)
![Maintenance](https://img.shields.io/maintenance/as-is/2024?color=gold)
# r6502
### Yet another NMOS 6502 emulator.
---
Designed to support `no-std` and not require an allocator nor any unsafe code.
Designed to support `no-std` and not require an allocator nor any unsafe code, and be reasonably fast.
The API of this crate shies away from implementing interrupt handling,
instead having you step the emulator one opcode at a time and handle them yourself.
@ -19,13 +20,13 @@ instead having you step the emulator one opcode at a time and handle them yourse
## Feature Flags
The following feature flags exist:
| 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. |
| bytemuck | Enables [bytemuck](https://docs.rs/bytemuck/) support. |
| arbitrary | Enables [arbitrary](https://docs.rs/arbitrary/) support. This will pull in `std`. |
| serde | Enables [serde](https://docs.rs/serde) support. |
| hashbrown | Enables [hashbrown](https://docs.rs/hashbrown) support. |
| 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. |
| bytemuck | Enables [bytemuck](https://docs.rs/bytemuck/) support. |
| arbitrary | Enables [arbitrary](https://docs.rs/arbitrary/) support. This will pull in `std`. |
| serde | Enables [serde](https://docs.rs/serde) support. |
| hashbrown | Enables [hashbrown](https://docs.rs/hashbrown) support. |
## Example
```rust ignore