forked from LearningLocker/learninglocker
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Provides more information and follows my template for a readme (my template has been refined and tested several times).
- Loading branch information
Showing
1 changed file
with
19 additions
and
25 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,36 +1,30 @@ | ||
Learning Locker | ||
================ | ||
|
||
Learning Locker is an open source Learning Record Store (LRS). | ||
# [Learning Locker](http://learninglocker.net) | ||
> An open source Learning Record Store (LRS) implementing the [xAPI](https://github.com/adlnet/xAPI-Spec/blob/master/xAPI.md) ([Tin Can API](http://tincanapi.com/)). | ||
[![Build Status](https://travis-ci.org/LearningLocker/learninglocker.svg?branch=master)](https://travis-ci.org/LearningLocker/learninglocker) | ||
[![Latest Stable Version](https://poser.pugx.org/learninglocker/learninglocker/v/stable.svg)](https://packagist.org/packages/learninglocker/learninglocker) | ||
[![Total Downloads](https://poser.pugx.org/learninglocker/learninglocker/downloads.svg)](https://packagist.org/packages/learninglocker/learninglocker) | ||
[![License](https://poser.pugx.org/learninglocker/learninglocker/license.svg)](https://packagist.org/packages/learninglocker/learninglocker) | ||
[![License](https://poser.pugx.org/learninglocker/learninglocker/license.svg)](http://opensource.org/licenses/GPL-3.0) | ||
[![Gitter](https://badges.gitter.im/Join Chat.svg)](https://gitter.im/LearningLocker/learninglocker?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) | ||
|
||
Homepage: http://learninglocker.net | ||
|
||
## Official Documentation | ||
|
||
* [Documentation site](http://docs.learninglocker.net) | ||
* [Documentation repo](http://github.com/learninglocker/docs) | ||
|
||
## License | ||
|
||
Learning Locker is open source software licensed under the [GPL v3](http://opensource.org/licenses/GPL-3.0) | ||
|
||
## Contributing To Learning Locker | ||
|
||
There are several ways you can get involved with Learning Locker. Find out more at the links below. | ||
*Learning Locker is copyright [HT2](http://ht2.co.uk)* | ||
|
||
* Code [http://docs.learninglocker.net/docs/contributing](http://docs.learninglocker.net/docs/contributing) | ||
* Community [http://learninglocker.net/community/get-involved/](http://learninglocker.net/community/get-involved/) | ||
## Users | ||
Please see our [documentation](http://docs.learninglocker.net) for installation, configuration, and usage instructions. | ||
|
||
## Contributors | ||
## Developers | ||
You may contribute to this project via [issues](/issues) and [pull request](/pulls), however, please see the [guidelines](/contributing.md) before doing so. You can also contribute by updating our [documentation](https://github.com/LearningLocker/docs). More information about how you can get involved can be found on the [Learning Locker website](http://learninglocker.net/community/get-involved/). | ||
|
||
* See contributors.md | ||
### Getting Started | ||
1. Install Learning Locker's [requirements](http://docs.learninglocker.net/requirements/). | ||
1. [Install and setup](http://docs.learninglocker.net/installation/) Learning Locker. | ||
4. Change the code. | ||
5. [Test](#testing) your code. See [testing](#testing) below for more information. | ||
6. Repeat from Step 4 or continue to step 7. | ||
7. Commit and push your changes to Github. | ||
8. Create a [pull request](/pulls) on Github (ensuring that you follow the [guidelines](/contributing.md)). | ||
|
||
## Copyright | ||
Note that Learning Locker is built upon the [Laravel](http://laravel.com/) PHP framework. | ||
|
||
Learning Locker is copyright HT2 (http://ht2.co.uk) | ||
### Testing | ||
You should try to ensure that `./vendor/bin/phpunit` runs without any errors before submitting a pull request. |