Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP

Loading…

Add README. #5

Merged
merged 3 commits into from

2 participants

@cmeiklejohn
Collaborator

Add README with instructions on bootstrapping, seeding, starting and configuring giddyup.

@seancribbs seancribbs was assigned
@seancribbs seancribbs merged commit 54fb80f into master
@seancribbs seancribbs removed their assignment
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Commits on Oct 10, 2012
  1. @cmeiklejohn

    Add screenshot.

    cmeiklejohn authored
  2. @cmeiklejohn

    Add README.

    cmeiklejohn authored
  3. @cmeiklejohn

    Update screenshot.

    cmeiklejohn authored
This page is out of date. Refresh to see the latest.
Showing with 19 additions and 3 deletions.
  1. +19 −3 README.md
  2. BIN  screenshot.png
View
22 README.md
@@ -1,4 +1,20 @@
-giddyup
-=======
+# GiddyUp
-The successor to basho_reins
+Welcome to the exciting world of `giddyup`.
+
+## What is GiddyUp?
+
+GiddyUp is the visual scorecard for [riak_test](http://github.com/basho/riak_test). GiddyUp provides two services, seeding ```riak_test``` with the list of tests which should be run for each platform, and receiving tests results and logs via a REST interface.
+
+## Bootstrapping and Configuration
+
+1. Migrate your database using ```bundle exec rake db:migrate```
+2. Seed your database with the default set of tests, platforms and
+ backend combinations using ```bundle exec rake db:seed```
+3. Create a ```.env``` file with the following environment variables:
+ ```DATABASE_URL```, ```S3_AKID```, ```S3_BUCKET``` and ```S3_SECRET```.
+4. Start your application with ```foreman start```
+
+## Screenshot
+
+![Screenshot](https://raw.github.com/basho/giddyup/master/screenshot.png "Screenshot")
View
BIN  screenshot.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Something went wrong with that request. Please try again.