From 9ff7bddfcdb5fbfc9d3fdb73c1636ec4e4a276d1 Mon Sep 17 00:00:00 2001
From: Michael Fairchild <mfairchild365@gmail.com>
Date: Wed, 20 Aug 2014 11:43:29 -0500
Subject: [PATCH] Implement the readme

---
 readme.md | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)

diff --git a/readme.md b/readme.md
index e69de29b..f8b4768a 100644
--- a/readme.md
+++ b/readme.md
@@ -0,0 +1,21 @@
+#Planet Red
+Planet Red is UNL's implementation of elgg
+
+#Directory Structure
+* elgg - the elgg directory.  Currently a submodule, checked out at 1.8.19
+* vagrant - various vagrant boxes for development/testing.  Use vagrant/dev/ for development
+* plugins - Our custom plugins such as auth and themes that need to be symlinked.  Keeping the plugins out of the elgg directory makes for easy upgrades.
+
+##Setup
+1. Initialize submodules by running `git submodule init` and then `gitsubmodule update`
+
+##Using Vagrant
+For now, use the dev vagrant box at vagrant/dev/
+1. `cd vagrant/dev/`
+2. `vagrant up`
+3. go to http://localhost:8005 to view the project 
+
+##TODO
+* implement the UNLedu Framework 4.0 theme at plugins/unl_theme
+* implement UNL auth at plugins/cas_auth_unl
+* make sure profile image routes still work
\ No newline at end of file
-- 
GitLab