Flesh out the README installation instructions
This commit is contained in:
parent
3076915e5e
commit
d0a3bfd3fb
35
README.md
35
README.md
@ -1,12 +1,27 @@
|
|||||||
Yaga
|
# 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.
|
|
||||||
|
|
||||||
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
|
It is released under the GPLv3 and may be released under a different license _**with permission**_.
|
||||||
=======
|
|
||||||
1. Create a folder called yaga in the vanilla/applications folder
|
|
||||||
2. Clone this repository into the yaga folder
|
## Installation
|
||||||
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
|
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
|
Loading…
x
Reference in New Issue
Block a user