From 1ab9822890f8df8b1be2b98d3a0e1c8bb6a5b8cb Mon Sep 17 00:00:00 2001
From: Ben S <ogham@bsago.me>
Date: Sun, 26 Oct 2014 17:36:28 +0000
Subject: [PATCH] Add a README

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..50912ec
--- /dev/null
+++ b/README.md
@@ -0,0 +1,34 @@
+BBEdit package for Rust
+=======================
+
+This is a BBEdit 11 Language Module for [Rust](http://www.rust-lang.org). It provides the following features:
+
+- Complete syntax highlighting
+    - Special support for lifetimes, attributes, and identifiers
+    - Customisable colours using the [BBEdit 11 colour thing](http://barebones.com/products/bbedit/bbedit11.html)
+- Language features
+    - Go to start of/end of/previous/next function
+    - Go to named symbol
+    - Indexed function menu
+
+By default, it highlights anything beginning with a capital letter in a certain colour. To turn this off, just change the Identifier colour to be the same as the default text colour in Preferences.
+
+### Installation
+
+The simplest way is to just download the package and put it in this folder:
+
+    ~/Application Support/BBEdit/Packages/
+
+Then restart your BBEdit and it should be picked up.
+
+### Compilation
+
+To compile your own version, you'll need Xcode. The default schema outputs a `.bblm`, which you'll have to turn into the package manually for now (sorry about that).
+
+In order to compile it, you'll need the BBEdit SDK. The project assumes it's mounted under `/Volumes/BBEdit SDK`.
+
+### TODO
+
+- Code folding
+- Snippets
+- Cargo integration