Minor - README updates

1.10.x
Yannick Warnier 11 years ago
parent a9d3d08e40
commit 6e4b1f2d08
  1. 47
      README.md

@ -1,27 +1,42 @@
Chamilo LMS
=============
A next generation Learning Management system focused on ease of use, collaboration and sharing.
What is Chamilo LMS?
--------------------
An advanced Learning Management system focused on ease of use and speed.
See documentation/index.html for a complete overview of Chamilo.
Versions differentiation
------------------------
Beware that the Chamilo Association hosts *two completely different applications*: Chamilo LMS (this software here) and Chamilo LCMS (a more experimental application focused on sharing learning objects, mostly, hosted on Bitbucket, not here).
Beware that the Chamilo Association supports *two completely different applications*: Chamilo LMS (this software here) and Chamilo LCMS (a more experimental application focused on sharing learning objects, mostly, hosted on Bitbucket, not here).
https://campus.chamilo.org, https://stable.chamilo.org and the vast majority of Chamilo installations around the world (98%) use Chamilo LMS.
Inside this Chamilo LMS project itself, there are two main "branches":
* Chamilo LMS 1.9.x offers a stable version of Chamilo that is made more stable with each new version
* Chamilo LMS HEAD (the default if you download it from Github) is in active development and will soon spawn the new 1.10 version (or v10) of Chamilo LMS. It is NOT to be used in production right now.
* Chamilo LMS 1.9.x is a stable version of Chamilo that is made more stable with each new version
* Chamilo LMS HEAD (the default if you download it from Github) is in active development and will soon spawn the new v10 version of Chamilo LMS. It is a general effort to reuse base components from other sources instead of maintaining near-deprecated packages). It should NOT to be used in production at this point.
If you are in search of the latest patches to your production installation, you should choose 1.9.x. If you are adventurous and look forward to contribute to something that *mostly* works but is still under heavy development, you should stick with the default HEAD branch.
If you are in search of the latest patches to your production installation, you should choose 1.9.x. If you are an adventurous developer and look forward to contribute to something that *mostly* works but is still under heavy development, you might try with the default HEAD branch.
Chamilo LMS v10 should be available in beta version around early 2015, so not too far away, and comes with an improved files structure and a lot of new dependencies/packages coming from Symfony and Composer. If you have time on your hands and are looking for long term contributions, that's where we'd like you to help.
Installation Chamilo v1.9.x
Requirements
------------
You need a working web server + PHP + MySQL setup.
Chamilo LMS supports PHP 5.4 and up, but we recommend PHP 5.5 (and up) with the
Zend Optimizer+ (opcache module) enabled for greater efficiency.
Chamilo requires MariaDB or MySQL v5.1 or higher.
Chamilo has been reported to work under Linux, Windows and Mac OSes.
Chamilo 1.9 has been reported to work with Apache 2 and Nginx. IIS installations
have been reported to work too, but testing has been insufficient to guarantee
stability.
Installing Chamilo v1.9.x
-------------------------
To install from Git (which means installing an unstable, development version of this application), do the following:
@ -45,8 +60,8 @@ This way, you'll stick to the 1.9.x branch only in this directory (your installa
Finally, if you are really looking into contributing back to Chamilo, you should (really) create yourself a Github account and "fork this project". You would then download Chamilo from your own Github repository first, then send changes to your repository and finally (once you're sure they're matching our coding conventions), submit a "Pull request" to Chamilo. This is the cleanest, more time-saving way to do it!
Installation Chamilo v10
------------
Installing Chamilo v10
----------------------
This version is *not* stable. It is not even alpha yet. Only for developers and
testing.
@ -68,6 +83,13 @@ composer update
Load localhost/chamilo/install.php in your browser and follow the instructions.
Documentation
-------------
A teachers guide is available in English and Spanish from [our website][1]
An admin guide is available in English from [our support website][2]
A developers guide for 1.9.x currently being written in English is available from [our "docs" repository][3]
Reporting bugs
--------------
@ -79,7 +101,7 @@ Always make sure you look for the Chamilo LMS subproject when submittingbug repo
Contributing
------------
When contributing patches (which we always welcome, as long as you agree to do that under the GNU/GPLv3 license), please ensure you respect our coding conventions: https://support.chamilo.org/projects/1/wiki/Coding_conventions (mostly PSR-2 with a few additional rules and hints).
When contributing patches (which we always welcome, as long as you agree to do that under the GNU/GPLv3 license), please ensure you respect our [coding conventions][4] (mostly PSR-2 with a few additional rules and hints).
Before you contribute, you should consider carefully the branch to which you want to contribute. The "master" branch (the default) is the continuously experimental branch of Chamilo, so by nature it is unstable and it is *not* used in production. The "1.9.x" branch (or the highest number ending with an ".x") is the currently stable branch. New releases are *tags* that are set on the stable branch when a new version is released. So, if you are looking to contribute on a bug of 1.9.8 in prevision for 1.9.9, you should use branch 1.9.x.
@ -121,4 +143,9 @@ Chamilo is licensed under the GPLv3 license.
Misc
----
[1]: http://www.chamilo.org/en/documentation
[2]: https://support.chamilo.org/issues/5653
[3]: https://github.com/chamilo/docs/tree/master/1.9/en/developer
[4]: https://support.chamilo.org/projects/1/wiki/Coding_conventions
[![Build Status](https://api.travis-ci.org/chamilo/chamilo-lms.png)](https://travis-ci.org/chamilo/chamilo-lms)

Loading…
Cancel
Save