From 11d443664b7a785b42cbbd5b96347bafa5ad273a Mon Sep 17 00:00:00 2001
From: varac <varacanero@zeromail.org>
Date: Wed, 13 Jul 2016 20:07:09 +0200
Subject: initial commit, import from pixelated_dashboard

---
 README.md | 60 ++++++++++++++++++++++++++++++++++--------------------------
 1 file changed, 34 insertions(+), 26 deletions(-)

(limited to 'README.md')

diff --git a/README.md b/README.md
index 6ff4065..8717cfa 100644
--- a/README.md
+++ b/README.md
@@ -1,33 +1,41 @@
-[![Gitter chat](https://badges.gitter.im/smashing.png)](https://gitter.im/Smashing)
+# LEAP Dashboard
+Check out http://shopify.github.com/dashing for more information.
 
-# [Smashing](https://github.com/Smashing/smashing/wiki)
 
-Smashing, the spiritual successor to [Dashing](https://github.com/Shopify/dashing), is a Sinatra based framework that lets you build excellent dashboards. It looks especially great on TVs.
+## Setup
 
-## Community
+Install bundler if required
 
-Feel free to submit issues for bugs, new features, and enhancements in [GitHub](https://github.com/Smashing/smashing/issues). For more general questions, or help with widgets, please use the [gitter chatroom](https://gitter.im/Smashing).
+```
+gem install bundler
+```
+
+Install app dependencies using bundler:
+
+```
+bundle install --path=vendor/bundle
+```
+
+If `bundle install` fails along the way, you're probably missing Xcode command line utilities: `xcode-select --install`
+
+If you're getting `fatal error: 'openssl/ssl.h' file not found` installing `eventmachine` dependency, you can try install it using the following command (make sure you have openssl installed):
+```bash
+gem install eventmachine -v '1.0.7' --  --with-cppflags='-I/usr/local/opt/openssl/include'
+```
 
-## Installation
+To gather the data, the dashboard needs access to your GoCI account & a GitHub token. You can store them and make them available to the app like so:
+```bash
+cp credentials_example credentials
+source credentials
+```
 
+For this dashboard you furthermore need nodejs installed, e.g.
 ```bash
-# Install bundler
-$ gem install bundler
-# Install smashing
-$ gem install smashing
-# Create a new project
-$ smashing new my-project
-# Change Directory into the project
-$ cd my-project
-# Install the bundle of project specific gems
-$ bundle
-# Start the example dashboard!
-$ smashing start
-```
-
-[Check out our wiki](https://github.com/Smashing/smashing/wiki).
-
-Note: This is a fork of the Dashing project, which is no longer being maintained. Read about that [here](https://github.com/Shopify/dashing/issues/711).
-
-## License
-Distributed under the [MIT license](MIT-LICENSE).
+nodenv local 0.10.36
+```
+
+Use dashing to build the dashboard or start it locally.
+```
+dashing start
+```
+See `dashing --help` for usage.
-- 
cgit v1.2.3