aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDeterminant <ted.sybil@gmail.com>2018-01-01 11:10:48 +0800
committerDeterminant <ted.sybil@gmail.com>2018-01-01 11:10:48 +0800
commit8ec734721562c4b1dc6a4c2dc2ed197b9f6a49d1 (patch)
tree2eb64159de4f2e810a13261217944934896af860
parentc50c39243e941aa9ca72ae3b0d4d0cf5141776bd (diff)
update readme
-rw-r--r--Cargo.toml2
-rw-r--r--README.rst9
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 <tederminant@gmail.com>"]
-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)