From 1f9e87e5d66b805dd255a632ade02089ddae266f Mon Sep 17 00:00:00 2001 From: Sam Coward Date: Thu, 25 Jul 2013 15:38:31 -0400 Subject: [PATCH] Add Quick start section to README --- README.markdown | 21 +++++++++++++++++---- 1 file changed, 17 insertions(+), 4 deletions(-) diff --git a/README.markdown b/README.markdown index 525296f1..6fbc5542 100644 --- a/README.markdown +++ b/README.markdown @@ -4,7 +4,22 @@ Cedar is a BDD-style Objective-C testing framework. It relies only on Foundation and C++11 features, thus it's not just suited for iOS and OSX codebases but other environments where these are available. -Documentation lives here: [https://github.com/pivotal/cedar/wiki](https://github.com/pivotal/cedar/wiki) +# Quick start + +* Install the Xcode command line tools package (Under the Preferences tab 'Downloads') if you haven't already done so. +* Run the following in a terminal: + +``` + $ curl -L https://raw.github.com/pivotal/cedar/master/install.sh | bash +``` + +* Restart Xcode +* Add Cedar target(s) to your app +* Start writing specs! + +# Documentation + +Documentation can be found on the [Cedar Wiki](https://github.com/pivotal/cedar/wiki) # Support and feedback @@ -20,6 +35,4 @@ Documentation lives here: [https://github.com/pivotal/cedar/wiki](https://github * [Dmitriy Kalinin](mailto:dmitriy@pivotallabs.com) ([cppforlife](http://github.com/cppforlife)), Pivotal Labs * [Adam Milligan](mailto:adam.milligan@alum.dartmouth.org) ([amilligan](http://github.com/amilligan)), Author -Copyright (c) 2010-2013 Pivotal Labs. This software is licensed under the MIT License. - -[![Mixpanel](https://api.mixpanel.com/track/?data=CXsiZXZlbnQiOiAiSG9tZSBWaXNpdCIsIA0KICAgIAkJInByb3BlcnRpZXMiOiB7ICAJDQogICAgICAgIAkidG9rZW4iOiAiNmJjZmE3MmQ5OGU2ZjdhZjFkNjQ3YWNmY2Q2NjMwNTEiICAgDQogICAgICAgICAgICAgICAgfQ0KICAgICAgICB9&ip=1&img=1)](http://mixpanel.com) +Copyright (c) 2010-2013 Pivotal Labs. This software is licensed under the MIT License. [![Mixpanel](https://api.mixpanel.com/track/?data=CXsiZXZlbnQiOiAiSG9tZSBWaXNpdCIsIA0KICAgIAkJInByb3BlcnRpZXMiOiB7ICAJDQogICAgICAgIAkidG9rZW4iOiAiNmJjZmE3MmQ5OGU2ZjdhZjFkNjQ3YWNmY2Q2NjMwNTEiICAgDQogICAgICAgICAgICAgICAgfQ0KICAgICAgICB9&ip=1&img=1)](http://mixpanel.com)