README

2022-12-12 19:09:06 +01:00
parent bf2df69a09
commit f55a060021
1 changed files with 13 additions and 2 deletions
--- a/README.md
+++ b/README.md
@@ -1,2 +1,13 @@
-# rusty_funge
-A befunge interpreter and debugger
+# Rusty Funge
+[Befunge](https://en.wikipedia.org/wiki/Befunge) interpreter and debugger for Befunge 93/98: [Funges](https://github.com/catseye/Funge-98/blob/master/doc/funge98.markdown#Whatis).
+
+## Installation
+Make sure Rust [Cargo](https://doc.rust-lang.org/cargo/) is installed, then:
+`cargo install --git https://github.com/wimpomp/rusty_funge.git`
+
+
+## Usage
+`befunge --help`
+
+## Examples
+`befunge examples/factorial0.bf 20 -d 0.05`