Permalink
Browse files

Added some documentation

  • Loading branch information...
1 parent 967c284 commit ff2eb3e94b91ec2d325b67a58f3d9b1f09d4dea7 @edavis10 committed Feb 27, 2010
Showing with 21 additions and 1 deletion.
  1. +21 −1 Readme.md
View
@@ -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

0 comments on commit ff2eb3e

Please sign in to comment.