summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorsalvis2018-08-04 16:41:49 (GMT)
committersalvis2018-08-04 16:41:49 (GMT)
commit6848e73d8bacd8d10c6c588bfade9d2b828d16c9 (patch)
tree78973fa9b1c77d9f0dd296c66e643f89e33e9292
parent1946b8800a8b46d6284fa7a47386936ee0084110 (diff)
Issue #2987140 by volkswagenchick: Fix README, useful links and formatting.
-rw-r--r--README.txt98
1 files changed, 70 insertions, 28 deletions
diff --git a/README.txt b/README.txt
index 9ac4acf..1188d35 100644
--- a/README.txt
+++ b/README.txt
@@ -1,6 +1,22 @@
-Devel
-==========
-Devel module contains helper functions and pages for Drupal developers and inquisitive admins:
+README.txt for Devel module
+---------------------------
+
+CONTENTS OF THIS FILE
+---------------------
+
+ * Introduction
+ * Requirements
+ * Included Modules and Features
+ * Recommended Modules
+ * Installation
+ * Configuration
+ * Maintainers
+
+INTRODUCTION
+------------
+
+Devel module contains helper functions and pages for Drupal developers and
+inquisitive admins:
- A block for running custom PHP on a page
- A block for quickly accessing devel pages
@@ -13,35 +29,61 @@ Devel module contains helper functions and pages for Drupal developers and inqui
This module is safe to use on a production site. Just be sure to only grant
'access development information' permission to developers.
-Devel Kint
-===================
-Provides a dpr() function, which pretty prints variables.
+ - For a full description of the module visit:
+ https://www.drupal.org/project/devel
+
+ - To submit bug reports and feature suggestions, or to track changes visit:
+ https://www.drupal.org/project/issues/devel
+
+
+REQUIREMENTS
+------------
+
+This module requires no modules outside of Drupal core.
+
+
+INCLUDED MODULES AND FEATURES
+-----------------------------
+
+Devel Kint - Provides a dpr() function, which pretty prints variables.
Useful during development. Also see similar helpers like dpm(), dvm().
-Webprofiler
-==============
-Adds a debug bar at bottom of all pages with tons of useful information like a query list,
-cache hit/miss data, memory profiling, page speed, php info, session info, etc.
+Webprofiler - Adds a debug bar at bottom of all pages with tons of useful
+information like a query list, cache hit/miss data, memory profiling, page
+speed, php info, session info, etc.
+
+Devel Generate - Bulk creates nodes, users, comment, terms for development. Has
+Drush integration.
+
+Drush Unit Testing - See develDrushTest.php for an example of unit testing of
+the Drush integration. This uses Drush's own test framework, based on PHPUnit.
+To run the tests, use run-tests-drush.sh. You may pass in any arguments that
+are valid for `phpunit`.
+
+
+RECOMMENDED MODULE
+------------------
-Devel Generate
-=================
-Bulk creates nodes, users, comment, terms for development. Has Drush integration.
+Devel Generate Extensions - Devel Images Provider allows to configure external
+providers for images.
-Devel Generate Extensions
-=========================
-Devel Images Provider [http://drupal.org/project/devel_image_provider] allows to configure external providers for images.
+ - http://drupal.org/project/devel_image_provider
+
+
+INSTALLATION
+------------
+
+ - Install the Devel module as you would normally install a contributed Drupal
+ module. Visit https://www.drupal.org/node/1897420 for further information.
-Drush Unit Testing
-==================
-See develDrushTest.php for an example of unit testing of the Drush integration.
-This uses Drush's own test framework, based on PHPUnit. To run the tests, use
-run-tests-drush.sh. You may pass in any arguments that are valid for `phpunit`.
Author/Maintainers
-======================
-- Moshe Weitzman <weitzman at tejasa DOT com> http://www.acquia.com
-- Hans Salvisberg <drupal at salvisberg DOT com>
-- Pedro Cambra https://drupal.org/user/122101/contact http://www.ymbra.com/
-- Juan Pablo Novillo https://www.drupal.org/u/juampynr
-- lussoluca https://www.drupal.org/u/lussoluca
-- willzyx https://www.drupal.org/u/willzyx
+------------------
+
+ - Moshe Weitzman (moshe weitzman) - https://www.drupal.org/u/moshe-weitzman
+ - Hans Salvisberg (salvis) - https://www.drupal.org/u/salvis
+ - Pedro Cambra https://drupal.org/user/122101/contact http://www.ymbra.com/
+ - Juan Pablo Novillo https://www.drupal.org/u/juampynr
+ - lussoluca https://www.drupal.org/u/lussoluca
+ - willzyx https://www.drupal.org/u/willzyx
+