Added some documentation

edavis10 · Feb 27, 2010 · ff2eb3e · ff2eb3e
1 parent 967c284
commit ff2eb3e
Showing 1 changed file with 21 additions and 1 deletion.
diff --git a/Readme.md b/Readme.md
@@ -1,4 +1,24 @@
-Missing items
+# My Shadow Puppet
+
+This is a configuration that I use with [shadow_puppet](http://reductivelabs.com/trac/puppet/wiki/ShadowPuppet) to build and configure my desktops.
+
+## Requirements
+
+* Ruby
+* Rubygems
+* shadow_puppet (see below)
+
+## Usage
+
+### Clean system (Debian)
+
+If you are installing to a clean system, a bootstrap script is provided to install any needed system dependencies, rubygems, and shadow_puppet.  Just run `ruby bootstrap.rb` (might need sudo).
+
+### Set or upgrade a system
+
+To run the tasks to setup your system (called manifests), just run @sudo shadow_puppet desktop_manifest.rb@.  You can also make other manifests for specific systems with different configurations (e.g. web_server_manifest.rb, rails_development_workstation.rb).
+
+## Missing items
 
 * Ruby gems
 * Desktop config