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.
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
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
-------------------
doctor
------
+------
Perform some checks on the environment to identify possible problems, and attempt to fix them automatically.
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
=======