Skip to content
Browse files

Explain how Sous Chef came to be and what's the development process like

  • Loading branch information...
1 parent ef02acf commit e776b5b14b7825f9925274b5985d47b8abd1581c @michaelklishin committed Aug 5, 2011
Showing with 21 additions and 1 deletion.
  1. +21 −1 README.md
View
22 README.md
@@ -1,7 +1,9 @@
# What is Travis Sous Chef
Travis Sous Chef is a repository that makes development and testing of Chef cookbooks (for travis-ci.org but
-not just) easy.
+not just) easy. It brings practices that the [Travis Development Team](https://github.com/travis-ci) uses to develop
+new and test modified [cookbooks](https://github.com/travis-ci/travis-cookbooks/tree/master/vagrant_base) for
+[Travis CI](http://travis-ci.org) to the masses.
## Dependencies
@@ -10,6 +12,24 @@ Sous Chef uses [Vagrant](http://vagrantup.com) and thus relies on [Virtual Box](
need to have Chef installed locally. It will only be run in a virtual machine.
+## How it works
+
+With Sous Chef, you use Vagrant and a locally running VirtualBox VM to develop and test your cookbooks. Sous Chef can use any collection of
+cookbooks: [those we use for travis-ci.org](https://github.com/travis-ci/travis-cookbooks/tree/master/vagrant_base), cookbooks you are using for
+commercial projects, cookbooks from the official OpsCode repository or anything else.
+
+With Sous Chef, you provision a locally running virtual machine managed by [Vagrant](http://vagrantup.com) in just one command. The process is
+set up to shorten the feedback loop:
+
+ * Modify your cookbook recipes (or templates/files in them)
+ * Run provisioning
+ * See and verify the result
+ * Rinse and repeat
+
+Once you are done with your cookbooks, just push them to a source control repository or rsync them to your server. Then destroy VM environment
+you were using in one command. Or just power off the VM and come back to work with it later.
+
+
## Getting started with Sous Chef
First install [VirtualBox 4.0.x](http://download.virtualbox.org/virtualbox/4.0.12) (4.1.0 has known issues and we recommend holding off with upgrades):

0 comments on commit e776b5b

Please sign in to comment.
Something went wrong with that request. Please try again.