From 8ec734721562c4b1dc6a4c2dc2ed197b9f6a49d1 Mon Sep 17 00:00:00 2001 From: Determinant Date: Mon, 1 Jan 2018 11:10:48 +0800 Subject: update readme --- Cargo.toml | 2 +- README.rst | 9 ++++----- 2 files changed, 5 insertions(+), 6 deletions(-) diff --git a/Cargo.toml b/Cargo.toml index a030298..8477e61 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -2,7 +2,7 @@ name = "runes" version = "0.1.3" authors = ["Determinant "] -description = "A no-std NES emulator library written purely in Rust." +description = "No-std NES emulator library and minimal emulator written purely in Rust." repository = "https://github.com/Determinant/runes" keywords = ["nes", "emulator", "6502"] categories = ["no-std", "emulators"] diff --git a/README.rst b/README.rst index 76d2dc7..7e41122 100644 --- a/README.rst +++ b/README.rst @@ -13,7 +13,7 @@ accurate (cycle-level accurate), light-weight and efficient emulation core library using Rust. Unlike sprocketnes_ or pinky_, RuNES strives to provide with a clean and minimal core library without standard library (i.e., without Box, Rc, Vectors, etc.) that could be compiled and easily ported to -embedded environments. Of course, a simple SDL-based GUI is also provided as a +embedded environments. Of course, a minimal SDL-based GUI is also provided as a demonstration of use. Feature @@ -38,10 +38,9 @@ Guidelines .. _sprocketnes: https://github.com/pcwalton/sprocketnes .. _pinky: https://github.com/koute/pinky -Build -===== +Build the Example Emulator +========================== :: - cargo build --release # build the library only (no std dep) - cargo build --examples --release # or build the example emulator (requires std) + cargo build --examples --release # (requires std, sdl2 and clap) -- cgit v1.2.3-70-g09d2