summaryrefslogtreecommitdiff
path: root/sqlbox/README.txt
diff options
context:
space:
mode:
authorJan Klemkow <j.klemkow@wemelug.de>2012-10-09 14:01:58 +0200
committerJan Klemkow <j.klemkow@wemelug.de>2012-10-09 14:01:58 +0200
commit459313e56b0653e4709694a7e86afc11be514097 (patch)
treea81656d8694e7a10dae8415f0d6ce7c29aeae294 /sqlbox/README.txt
parentb5b11fc16c37bfa9445bf66e68b324636cc6c8f8 (diff)
downloadsqltutor-plugin-459313e56b0653e4709694a7e86afc11be514097.tar.gz
sqltutor-plugin-459313e56b0653e4709694a7e86afc11be514097.tar.bz2
sqltutor-plugin-459313e56b0653e4709694a7e86afc11be514097.zip
add dummy module
Diffstat (limited to 'sqlbox/README.txt')
-rw-r--r--sqlbox/README.txt42
1 files changed, 42 insertions, 0 deletions
diff --git a/sqlbox/README.txt b/sqlbox/README.txt
new file mode 100644
index 0000000..3b8a9ec
--- /dev/null
+++ b/sqlbox/README.txt
@@ -0,0 +1,42 @@
+The following steps should get you up and running with
+this module template code.
+
+* DO NOT PANIC!
+
+* Unzip the archive and read this file
+
+* Rename the newmodule/ folder to the name of your module (eg "widget").
+ The module folder MUST be lower case. You should check the CVS contrib
+ area at http://cvs.moodle.org/contrib/plugins/mod/ to make sure that
+ your name is not already used by an other module.
+
+* Edit all the files in this directory and its subdirectories and change
+ all the instances of the string "newmodule" to your module name
+ (eg "widget"). If you are using Linux, you can use the following command
+ $ find . -type f -exec sed -i 's/newmodule/widget/g' {} \;
+
+* Rename the file lang/en/newmodule.php to lang/en/widget.php
+ where "widget" is the name of your module
+
+* Place the widget folder into the /mod folder of the moodle
+ directory.
+
+* Go to Settings > Site Administration > Development > XMLDB editor
+ and modify the module's tables.
+
+* Modify version.php and set the initial version of you module.
+
+* Visit Settings > Site Administration > Notifications, you should find
+ the module's tables successfully created
+
+* Go to Site Administration > Plugins > Activity modules > Manage activities
+ and you should find that this newmodule has been added to the list of
+ installed modules.
+
+* You may now proceed to run your own code in an attempt to develop
+ your module. You will probably want to modify mod_form.php and view.php
+ as a first step. Check db/access.php to add capabilities.
+
+We encourage you to share your code and experience - visit http://moodle.org
+
+Good luck!