Updated the readme file for various things
authorFrederic Massart <fmcell@gmail.com>
Wed, 2 Apr 2014 17:07:45 +0000 (01:07 +0800)
committerFrederic Massart <fmcell@gmail.com>
Wed, 2 Apr 2014 17:07:45 +0000 (01:07 +0800)
README.md

index 4608589..71df5a1 100644 (file)
--- a/README.md
+++ b/README.md
@@ -6,7 +6,8 @@ A collection of tools meant to make developers' lives easier.
 Requirements
 ============
 
-- Python 2.7 (or Python 2.6 with the package _python-argparse_)
+- Linux or Mac OS
+- Python 2.7
 - MySQL or PostgreSQL
 
 Most of the tools work on Moodle 1.9 onwards, but some CLI scripts required by MDK might not be available in all versions.
@@ -22,12 +23,16 @@ Get some help on a command using:
 
     mdk <command> --help
 
+Also check the [wiki](https://github.com/FMCorz/mdk/wiki).
+
 Installation
 ============
 
 Ubuntu package
 --------------
 
+_This method is currently not recommended, the package is outdated. Maintainer wanted!_
+
     sudo apt-add-repository ppa:2x1cq-fred-7nqa6/ppa
     sudo apt-get update
     sudo apt-get install moodle-sdk
@@ -44,6 +49,11 @@ Try the following command to create a typical Stable Master instance (this will
 
 Now you should be able to access it from http://moodle-sdk/stable_master.
 
+Mac OS
+------
+
+Using [Homebrew](http://brew.sh/), please refer to this [formula](https://github.com/danpoltawski/homebrew-mdk).
+
 Manual installation
 -------------------
 
@@ -183,7 +193,7 @@ Compile the LESS files from Bootstrapbase
 
 
 doctor
------
+------
 
 Perform some checks on the environment to identify possible problems, and attempt to fix them automatically.
 
@@ -396,6 +406,17 @@ You can write custom scripts and execute them on your instances using the comman
 
 Scripts are very handy when it comes to performing more complexed tasks.
 
+Shipped scripts
+---------------
+
+The following scripts are available with MDK:
+
+* `dev`: Changes a portion of Moodle settings to enable development mode
+* `enrol`: Enrols users in any existing course
+* `undev`: Reverts the changes made by `dev`
+* `users`: Creates a set of users
+* `webservices`: Does all the set up of webservices for you
+
 License
 =======