Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Better README, updated LICENSE

  • Loading branch information...
commit d52df666163867ed6ed6920d8f04eda5d67c1f50 1 parent 044c82b
Brian Cunnie and Doc Ritezel authored
Showing with 47 additions and 36 deletions.
  1. +1 −1  LICENSE.txt
  2. +46 −35 README.md
View
2  LICENSE.txt
@@ -1,6 +1,6 @@
The MIT License
-Copyright (c) 2009-2010 Matthew Kocher, Steve Conover and Pivotal Labs
+Copyright (c) 2009-2013 Pivotal Labs
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
View
81 README.md
@@ -3,6 +3,11 @@
A repeatable, documented, decomposable, shareable and iterative OSX (ruby) development environment
+Features
+--------
+Pivotal Workstation automates the process of installing common applications such as Google Chrome, Firefox, homebrew, and RubyMine. Pivotal Workstation also sets OSX preferences such as dock hiding or key repeat rate. Finally, Pivotal Workstation configures command line tools such as git and ssh.
+
+
Installation
------------
@@ -23,56 +28,62 @@ gem install soloist
soloist
```
+Configuration
+-------------
+You may want to change the default applications or preferences. For example, you might want to install only Chrome and Sublime Text. In that case, your `soloistrc` would look like this:
-# NOTICE
-Pivotal Workstation is moving to using community cookbooks, and now depends on [opscode-cookbooks/dmg](https://github.com/opscode-cookbooks/dmg). You will need to clone the dmg cookbook alongside pivotal_workstation.
-
- cd ~/cookbooks; git clone https://github.com/opscode-cookbooks/dmg
-
-# Why?
-
-It takes a long time to set up a workstation, and doing it by hand leads to as many different setups as you have workstations. Pivotal Workstation automates the installation the applications you want (the canned ones, e.g. Chrome, Firefox, RubyMine, as well as the compiled ones, i.e. homebrew's suite) and tweaks the settings you usually set by hand. Pivotal Workstation automates the process so you can decide what you want your machine to look like then do other things while your workstation chugs away, downloading, compiling, installing and configuring.
+```yaml
+cookbook_paths:
+- cookbooks
+recipes:
+- pivotal_workstation::chrome
+- pivotal_workstation::sublime_text
+```
-# OK, I'm ready to dive in. How should I use this?
-First, make sure you've got Xcode and the Xcode command line tools installed, then:
+Configuration Interfaces
+------------------------
+There are two online tools you can use to generate `soloistrc` files:
-- [SoloWizard](http://www.solowizard.com/)
+- [SoloWizard](http://www.solowizard.com)
- This is the easiest way to get started, and it only involves cutting-and-pasting one line. Many thanks to [Tom Hallett](https://github.com/tommyh/).
+ This is the easiest way to get started, and it only involves cutting-and-pasting one line. Many thanks to [Tom Hallett](https://github.com/tommyh).
-- [soloistrc builder](http://soloistrc-builder.herokuapp.com/)
+- [soloistrc builder](http://soloistrc-builder.herokuapp.com)
- Soloistrc Builder can be pointed at any cookbook and will help you build a soloistrc. Many thanks to [Winston Teo](https://github.com/winston/).
+ Soloistrc Builder can be pointed at any cookbook and will help you build a soloistrc. Many thanks to [Winston Teo](https://github.com/winston).
-# Background
-Development environments are very personal, yet pairing requires some standard be agreed upon. Traditionally, Pivotal relied on imaging workstations from a gold master image which was updated as time allowed. Creating an image that satisfies everyone is impossible, and creating one that satisfies most people is a time consuming process which happened when Apple happened to release hardware which was not compatible with the old image. Chef and the Pivotal Workstation cookbook allows bringing up a new rails development environment with almost no effort, decide on standards on a per-project basis, then share changes with the rest of the users of the pivotal_workstation cookbook as time goes on. Another motivation was to reduce the amount of time spent at standup discussing how to get xyz to compile/run/launch/work in development.
+Background
+----------
+Traditionally, Pivotal Labs relied on imaging workstations from a gold master image which was updated as time allowed. Pivotal Workstation creates a development environment with almost no effort. See the [recipes folder](https://github.com/pivotal/pivotal_workstation/tree/master/recipes) for a complete list of possible recipes for your `~/soloistrc` file.
-# I'm just setting up my laptop, this all sounds like overkill.
-It might be, but it's probably not. Have you ever spent hours trying to get the mysql gem to compile? Do you go to RVM's home page to figure out how to install it? What about homebrew? Do you not test SSL on your local machine because getting nginx set up with a self signed certificate would take most of the morning? Do you fear setting up a new machine because you'll spend a week running into things you vaguely remember how to fix?
+Many recipes require [homebrew](https://github.com/mxcl/homebrew). Other recipes will overwrite your `.bash_profile`. `chef-solo` runs as root and may make system-wide changes.
-# Ok, what exactly do I get?
-Anything you want, nothing you don't. Packages are built with Homebrew, Ruby is installed with RVM. See the [recipes folder](https://github.com/pivotal/pivotal_workstation/tree/master/recipes) for a complete list. Many recipes require homebrew or overwriting your .bash_profile. If you want something that doesn't have a recipe, write one and make a pull request.
-# Hey, I'm attached to my .bash_profile, isn't this dangerous?
-Yes. Chef needs to be run as root - it can do whatever it wants to your system. The recipes have to make some hard assumptions about your machine, and take over parts of your system. Reading any recipe you're thinking of using is a very good idea - a chef recipe shouldn't be difficult to follow, and it'll give you an idea of how to make your own. In the case of your bash profile, it'll be backed up by chef (to /var/chef/backup), and you can move it into ~/.bash_profile_includes/ and it will be sourced by the provided .bash_profile.
-
-# I want to write my own recipe, what should I know?
-Soloist (or your preferred method of running chef) usually runs chef-solo as root. This means the current user is root, and ~ will be expanded to root's home directory. Some constants, WS_USER and WS_HOME are available when needed.
+Contributing
+------------
+* Fork the project
+* Make your feature addition or bug fix
+* Send me a pull request; bonus points for topic branches
+* If you submit several recipes, break them into several pull requests
-# I'm still running Lion; I haven't upgraded to Mountain Lion
-The current version is tested only tested on Mountain Lion (OS X 10.8); [Here](https://github.com/pivotal/pivotal_workstation/zipball/last_lion_release) you'll find the last release we tested on Lion (OS X 10.7).
-# Does this thing actually work?
-Yes. At Pivotal we take testing seriously, and have all projects under CI. Occasionally dependencies outside of our control disappear between times we are working on pivotal_workstation. If you come across something which has broken, we welcome pull requests.
+Authors
+-------
+ * [Matthew Kocher](https://github.com/mkocher) & [Steve Conover](https://github.com/sconover)
+ * [Brian Cunnie](https://github.com/cunnie)
+ * [Doc Ritezel](https://github.com/ohrite)
-# Forking and Pull Requests
-Pull requests are welcomed. Creating a cookbook to keep along side pivotal_workstation allows for easy separation between personal/project metadata/recipes and recipes that are of general utility.
-Chef node attributes allow for easy overriding in your own cookbook. All attributes in pivotal_workstation are set at the default level, so you may simply set node.normal or node.override in your own cookbook. We don't tend to extract node attributes preemptively, but pull requests extracting a node variable so you can override it in your own cookbook are welcomed.
+Thanks
+------
+ * [Roderik van der Veer](https://github.com/roderik)
+ * [Patrick Connolly](https://github.com/patcon)
+ * [Winston Teo](https://github.com/winston)
+ * [Tom Hallett](https://github.com/tommyh)
-If you are making a pull request, please make your changes on a branch, rebase them to master of pivotal_workstation and open a pull request.
-# To Whom do I complain?
-pivotal_workstation started as a side project of [Matthew Kocher](https://github.com/mkocher) and [Steve Conover](https://github.com/sconover) of Pivotal Labs in 2009, and made the move to a supported pivotal project at the beginning of 2010. [Brian Cunnie](https://github.com/briancunnie) now wrangles the many developers at Pivotal Labs who contribute and keeps the project going.
+Copyright
+---------
+Copyright © Pivotal Labs. See [LICENSE.txt](https://raw.github.com/pivotal/pivotal_workstation/master/LICENSE.txt) for details.
Please sign in to comment.
Something went wrong with that request. Please try again.