From d0a3bfd3fb4cd59a04dd1cf7d2816120242877a3 Mon Sep 17 00:00:00 2001 From: Kasper Kronborg Isager Date: Fri, 20 Dec 2013 18:33:21 -0500 Subject: [PATCH] Flesh out the README installation instructions --- README.md | 35 +++++++++++++++++++++++++---------- 1 file changed, 25 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 96b1012..b7753b2 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,27 @@ -Yaga -==== -**Y**et **A**nother **G**amification **A**pplication is a Garden application that provides a gamification platform for other Garden applications. It integrates by default with Vanilla Forums. Out of the box, it provides Reactions, Badges, and Ranks. +# Yaga -It is released under the GPLv3 and may be released under a different license _with permission_. +__Y__et __A__nother __G__amification __A__pplication is a Garden application that provides a gamification platform for other Garden applications. It integrates by default with Vanilla Forums. Out of the box, it provides Reactions, Badges, and Ranks. -Install -======= -1. Create a folder called yaga in the vanilla/applications folder -2. Clone this repository into the yaga folder -3. Enable the application in your dashboard -4. Configure the Yaga application via the Gamification panel you will now find in the dashboard side panel +It is released under the GPLv3 and may be released under a different license _**with permission**_. + + +## Installation + +To get up and running with Yaga, either: + +* __[Download the latest stable release](http://vanillaforums.org/get/yaga-application)__ +* Clone the repository into the `applications` directory: + +```sh +$ cd path-to-applications +$ git clone git://github.com/hgtonight/Application-Yaga.git yaga +``` + +> __NB:__ Make sure to double check that the installed folder is named `yaga`! + +The latter option is only recommend if you're familiar with git. + +Once you've added the application to your Vanilla installation, you need to activate and configure it in the dashboard. Once activated, you will see a new "Gamification" menu in the dashboard sidebar where you can configure each individual part of the Yaga application. + +--- +Copyright 2013 © Zachary Doll \ No newline at end of file