summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorgit2011-08-15 04:02:16 (GMT)
committer Randy Fay2011-08-15 04:02:16 (GMT)
commit9e1565ffbabc565df37f7af9182a98d40d901d2b (patch)
tree0ed0be38920813ccaad60b4284842f04bc99ed96
parenta7f9eba2d91ffea5f855c8a5f0f47401203655d9 (diff)
Issue #1050188 by Chemtox: Improve the readme to explain the nav menu
-rw-r--r--README.txt21
1 files changed, 15 insertions, 6 deletions
diff --git a/README.txt b/README.txt
index 358d8ca..fc83a78 100644
--- a/README.txt
+++ b/README.txt
@@ -1,11 +1,20 @@
+Examples for Developers
+http://drupal.org/project/examples
-Examples modules
+This set of modules is intended to provide small working examples of Drupal's features and APIs. The modules strive to be simple, well documented and modification friendly to help developers quickly learn their inner workings, with a little reading and hands on experience.
-This set of modules is intended to show how to use various Drupal features.
-It's intended only for developers.
+You can have a quick glimpse at the current Examples in the demo site: http://d6.drupalexamples.info/
-If you find a problem, bad comment, poor usage, out-of-date API usage,
-etc., please post an issue in the issue queue at
-http://drupal.org/project/examples.
+Suggestions, corrections and new examples are welcome. Don't be shy if you're just starting, as precisely because of that you will know the questions and problems of a newcomer better than a seasoned developer!
+Setup
+
+1. Install Examples for Developers (unpacking it to your Drupal sites/all/modules directory if you're isntalling by hand, for example).
+2. Enable any Example modules in Admin menu > Site building > Modules.
+3. Rebuild access permissions if you are prompted to.
+4. Profit! The examples will appear in your Navigation menu (on the left side bar by default; you'll need to reenable it if you removed it).
+
+Now you can read the code and it's comments and see the result, experiment with it, and hopefully quickly grasp it's working.
+
+If you find a problem, incorrect comment, obsolete or improper code or such, please let us know by creating a new issue at http://drupal.org/project/issues/examples