Skip to content

Commit

Permalink
Adds more explanation to the README
Browse files Browse the repository at this point in the history
Closes #3
  • Loading branch information
Brian Kelly committed Jan 26, 2016
1 parent 85cdbf7 commit ccc04c7
Showing 1 changed file with 25 additions and 5 deletions.
30 changes: 25 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,15 @@
# Workstation Setup

This project automates the process of setting up a new Pivotal Labs machine.
This project automates the process of setting up a new Pivotal Labs machine using a simple [Bash](https://www.gnu.org/software/bash/) script.

## Getting Started

**Warning: the automation script is currently aggressive about what it does and will overwrite vim configurations, bash-it configurations, etc.**

## Getting Started
- Update to [El Capitan](https://itunes.apple.com/us/app/os-x-el-capitan/id1018109117)
- Install [Xcode 7](https://itunes.apple.com/us/app/xcode/id497799835)

- Update to El Capitan
- Install [Xcode from the App Store](https://itunes.apple.com/us/app/xcode/id497799835)
Then open up the OS X Terminal and run the following commands:

```sh
$ cd workspace
Expand All @@ -16,10 +18,28 @@ $ cd workstation-setup
$ ./script/setup.sh
```

## Having problems?

If you're having problems using the setup script, please let us know by [opening an issue](https://github.com/pivotal/workstation-setup/issues/new).

## Customizing

If you'd like to customize this project for your own use:

- Fork the project
- Edit `./scripts/setup.sh` to you liking
- Edit `./scripts/setup.sh` to your liking
- Profit

## What about sprout-wrap?

This project is provided as an alternative to the [pivotal-sprout/sprout-wrap](https://github.com/pivotal-sprout/sprout-wrap) project. You are encouraged to use that project if it better suits your needs.

The goals of this projects is to keep the setup process simple and up to date:

- A bash script is easy to manage
- Everything is in one repository
- The project name is informative
- Keep it easy to fork and customize
- It has very limited requirements: git, bash and Ruby are all available on OS X by default

Please see [this GitHub issue](https://github.com/pivotal/workstation-setup/issues/3) for more discussion on the subject.

0 comments on commit ccc04c7

Please sign in to comment.