aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJon Bernard <jbernard@tuxion.com>2014-07-27 08:13:27 -0400
committerJon Bernard <jbernard@tuxion.com>2014-07-27 08:13:27 -0400
commit5c51034bb928d3d58cac855ed83253042fd758dc (patch)
tree85b3f6e75b1dbe2a11588cf5881888c8416defe8 /README.md
parent387a9af68c4270e17211ec4d97553180069c3a0f (diff)
downloadvimcasts-5c51034bb928d3d58cac855ed83253042fd758dc.zip
Add README
Diffstat (limited to 'README.md')
-rw-r--r--README.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..9a34513
--- /dev/null
+++ b/README.md
@@ -0,0 +1,22 @@
+## Vimcasts
+
+A git annex repository of Vimcast episodes.
+
+This allows you to selectively fetch and store locally any episodes you wish to
+view or use as a reference. I find myself doing this often, especially for the
+fugitive series.
+
+## Usage
+
+To use this repository, you must have `git` and `git-annex` installed.
+
+To fetch a particular episode in OGV format:
+
+ git annex get 01/show_invisibles.ogv
+
+To fetch all episodes in m4v format:
+
+ git annex get */*.m4v
+
+See the [git-annex](http://git-annex.branchable.com/) documentation for further
+information.