From: David Kerkeslager <kerkeslager@gmail.com>
Date: Sat, 11 May 2019 15:37:14 +0000 (-0400)
Subject: Update the README
X-Git-Url: https://code.kerkeslager.com/?a=commitdiff_plain;h=b7dc8998fabc07d4d1bc9fe7cd8ded7c9fc32848;p=fur

Update the README
---

diff --git a/README.md b/README.md
index b70a0d4..2b7ff47 100644
--- a/README.md
+++ b/README.md
@@ -3,15 +3,29 @@
 Fur is a programming language for the next millenium. In 1000 years, humans will likely still like
 furry animals, so Fur is named in their honor.
 
+## Installation
+
+1. Create and activate a virtual environment with Python 3. On most systems, this will look something like `python3 -m venv .env/ && .env/bin/activate`.
+2. Install dependencies from `requirements.txt` using `pip`: `pip install -r requirements.txt`.
+3. That's all!
+
+## Integration tests
+
+To run the unit tests, run `python integration_tests.py`.
+
+# Running
+
 Example Fur programs are in the `examples/` folder. The main compiler (`main.py`) compiles Fur
 programs to C. An example of usage:
 
-    ~/fur$ python3 main.py examples/01_hello.fur
+    ~/fur$ python main.py examples/01_hello.fur
     ~/fur$ gcc examples/01_hello.fur.c 
     ~/fur$ ./a.out
     Hello, world~/fur$ 
 
-Fur is GPL and will only ever target GPL compilers. Fur supports closures, integer math, boolean
+## Disclaimers
+
+Fur is GPL 3 and will only ever target GPL compilers. Fur supports closures, integer math, boolean
 logic, lists, structures (similar to objects), and strings (implemented as
 [ropes](https://en.wikipedia.org/wiki/Rope_(data_structure))).  It doesn't yet support
 exceptions, multithreading, modules, or anything resembling a standard library.  If that sounds