From 51781581d78b78b58b4d3cc239ec9a6008a3ebb8 Mon Sep 17 00:00:00 2001
From: Yuichi Nishiwaki <yuichi.nishiwaki@gmail.com>
Date: Thu, 17 Oct 2013 14:09:39 +0900
Subject: [PATCH] add README.md

---
 README.md | 32 ++++++++++++++++++++++++++++++++
 1 file changed, 32 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 00000000..9cda54ad
--- /dev/null
+++ b/README.md
@@ -0,0 +1,32 @@
+
+	This product is developed at the second-grade course, Informatic Science Basic Experiment class at the University of Tokyo.
+
+# Picrin - a lightweight scheme interpreter
+
+## Freatures
+
+- R7RS compatibility (but partial support)
+- reentrant design (all VM states are stored in single global state object)
+- bytecode interpreter (based on Stack VM technology)
+- direct threading VM
+- exact GC (simple mark and sweep strategy)
+
+## How to use it
+
+- build
+
+		$ make build
+
+	built executable binary will be under bin/ directory.
+
+- run
+
+	Simply directly run the binary `bin/picrin` from terminal, or you can use `make` to execute it like this.
+
+		$ make run
+	
+In the default option, when `make` command is called without arguments, it builds the binary and right after that dropped into the picrin interactive shell (REPL).
+
+## Authors
+
+Yuichi Nishiwaki (yuichi.nishiwaki at gmail.com)