Updating readme

1.10.x
Julio Montoya 10 years ago
parent 2de1024e4f
commit 1a49b0cdf3
  1. 55
      README.md

@ -15,14 +15,15 @@ https://campus.chamilo.org, https://stable.chamilo.org and the vast majority of
Inside this Chamilo LMS project itself, there are two main "branches":
* 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.
* Chamilo LMS HEAD (the default if you download it from Github) is in active development and will soon spawn the new v2 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 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.
Chamilo LMS v2 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.
Requirements
------------
# Chamilo v1.9.x
### Requirements
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.
@ -35,8 +36,7 @@ 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
-------------------------
### Installation
To install from Git (which means installing an unstable, development version of this application), do the following:
@ -60,13 +60,23 @@ 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!
Installing Chamilo v10
----------------------
# Chamilo v2
This version is *not* stable. It is not even alpha yet. Only for developers and
testing.
### Requirements
Chamilo LMS supports PHP 5.4 and up, but we recommend PHP 5.6 (and up).
Chamilo requires MariaDB or MySQL v5.1 or higher.
Chamilo has been reported to work under Linux, Windows and Mac OSes.
### Installation
Command-line install:
```
git clone https://github.com/chamilo/chamilo-lms.git chamilo
cd chamilo
@ -75,6 +85,7 @@ php app/console chamilo:install --force --drop-database
```
Browser install:
```
git clone https://github.com/chamilo/chamilo-lms.git chamilo
cd chamilo
@ -83,6 +94,26 @@ composer update
Load localhost/chamilo/install.php in your browser and follow the instructions.
Behat scenarios
-------------
See the /features folder
Then download [Selenium Server](http://seleniumhq.org/download/), and run it:
```
java -jar selenium-server-standalone-2.44.0.jar
```
Create a virtual host with this name "my.chamilo_test.net"
This virtual host is use inside the /behat.yml file
Run your scenario using the behat console:
```
bin/behat
```
Documentation
-------------
@ -112,13 +143,13 @@ Manual testing
You can always check the impact of your changes and confirm with other users on the following portals, which are automatically updated every 15 minutes:
* https://stable.chamilo.org for versions 1.9.x
* https://unstable.chamilo.org for development version (currently 1.10) - this one doesn't automatically apply database changes, so it is more likely to break often
* https://unstable.chamilo.org for development version (currently v2) - this one doesn't automatically apply database changes, so it is more likely to break often
These are *NOT* production portals. Your content *WILL* be deleted once every now and then. It is completely public and anyone can enter and delete your content if they want to. DO NOT put important content there.
Automated testing
-----------------
We have a few automated tests written in SimpleTest but, after a series of unsuccessful attempts at developing the right set of tests covering 100% of the code, we decided to give up and rewrite an important part of Chamilo's legacy code. This is what v10, our current master branch, is about (between other things).
We have a few automated tests written in SimpleTest but, after a series of unsuccessful attempts at developing the right set of tests covering 100% of the code, we decided to give up and rewrite an important part of Chamilo's legacy code. This is what v2, our current master branch, is about (between other things).
You can find the existing tests in the tests/ directory in any clone generated from GitHub (you won't find it in the downloadable archive on our website, though).
@ -126,14 +157,14 @@ Learn more
----------
For news, events and more information on Chamilo LMS please visit
http://www.chamilo.org/
[http://www.chamilo.org](http://www.chamilo.org)
Community
----------
Check out #chamilo on irc.freenode.net.
Visit the official Chamilo Forum: http://www.chamilo.org/forum
Visit the official Chamilo Forum: [http://www.chamilo.org/forum](http://www.chamilo.org/forum)
License
----------

Loading…
Cancel
Save