From: Frederic Massart <fred@moodle.com>
Date: Thu, 21 Feb 2013 05:54:40 +0000 (+0800)
Subject: Updated documentation
X-Git-Tag: v0.4~93
X-Git-Url: https://git.cameron1729.xyz/?a=commitdiff_plain;h=b25fc08410e330d2edc3b8621023b4a1fc90e490;p=mdk.git

Updated documentation
---

diff --git a/CHANGELOG.md b/CHANGELOG.md
new file mode 100644
index 0000000..72e232b
--- /dev/null
+++ b/CHANGELOG.md
@@ -0,0 +1,17 @@
+Changelog
+=========
+
+v0.3
+----
+
+* New command `behat` which is equivalent to `phpunit`
+* New command `pull` to fetch a patch from a tracker issue
+* New script `webservices` to entirely enable the web services
+* `push` now updates the Git information on the tracker issue (Thanks to Damyon Wiese)
+* `phpunit` can also run the tests after initialising the environment
+* `update --update-cache` can proceed with the updates after updating the cached remotes
+* `info` can be used to edit settings ($CFG properties) in config.php
+* `init` has been a bit simplified
+* Basic support of shell commands in aliases
+* The settings in config.json are read from different locations, any missing setting will be read from config-dist.json
+* Bug fixes
diff --git a/README.md b/README.md
index 2dbe778..97097d7 100644
--- a/README.md
+++ b/README.md
@@ -33,7 +33,7 @@ Ubuntu package
     sudo apt-get install moodle-sdk
     # Most settings are probably good as they are, just configure your remote and database engines.
     sudo mdk init
-    # The next line prevents your from logging out and in again.
+    # The next line prevents you from logging out and in again.
     sudo su `whoami`
 
 You're done!
diff --git a/config-dist.json b/config-dist.json
index a7a4857..e22240d 100644
--- a/config-dist.json
+++ b/config-dist.json
@@ -149,6 +149,10 @@
     "masterBranch": 25,
 
     // Aliases for MDK commands.
+    // An alias starting with a ! will be executed through the command line.
+    // Examples:
+    //   "upall": "update --all". `mdk upall` will execute `mdk update --all`
+    //   "ls": "!ls -al". `mdk ls` will execute `ls -al`
     "aliases": {
         "list": "info -l"
     }