From 7f40ffc5ee95612ddbac0940963ac5977acc2175 Mon Sep 17 00:00:00 2001 From: baltdev Date: Mon, 1 Apr 2024 23:31:50 -0500 Subject: [PATCH] Add maintenance badge --- .idea/vcs.xml | 6 ++++++ Cargo.toml | 7 +++++-- README.md | 17 +++++++++-------- 3 files changed, 20 insertions(+), 10 deletions(-) create mode 100644 .idea/vcs.xml diff --git a/.idea/vcs.xml b/.idea/vcs.xml new file mode 100644 index 0000000..94a25f7 --- /dev/null +++ b/.idea/vcs.xml @@ -0,0 +1,6 @@ + + + + + + \ No newline at end of file diff --git a/Cargo.toml b/Cargo.toml index a2f6a3d..31e248a 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -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 diff --git a/README.md b/README.md index 05226bf..ce5ae56 100644 --- a/README.md +++ b/README.md @@ -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.
Enabled by default. Disable if you're writing a NES emulator.
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.
Enabled by default. Disable if you're writing a NES emulator.
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