Add ReadMe

sanssecours · Sep 21, 2016 · 1bb674d · 1bb674d
1 parent d305bc9
commit 1bb674d
Show file tree

Hide file tree

Showing 2 changed files with 28 additions and 0 deletions.
diff --git a/Documentation/Cram.png b/Documentation/Cram.png
diff --git a/ReadMe.md b/ReadMe.md
@@ -0,0 +1,28 @@
+# Cram Bundle
+
+This [TextMate](https://github.com/textmate/textmate) bundle provides support for [Cram](https://bitheap.org/cram), a functional testing framework for command line applications.
+
+![Cram](Documentation/Cram.png)
+
+# Installation
+
+## Manual
+
+1. Download the latest [release][]
+2. Unzip the archive
+3. Double-Click on “Cram.tmbundle”
+
+[release]: http://github.com/sanssecours/Cram.tmbundle/releases
+
+## Terminal
+
+```sh
+mkdir -p "$HOME/Library/Application Support/Avian/Bundles"
+cd "$HOME/Library/Application Support/Avian/Bundles"
+git clone https://github.com/sanssecours/Cram.tmbundle
+```
+
+# Requirements
+
+- **Operating System:** OS X 10.10.0 or newer
+- **TextMate:** 2.0-beta.12.11 or newer