hello

the title self-explains. having a readme would probably solve 90% of the support tickets.

how about this? (sample from colorbox module)

Drupal Views Infinite Scroll module:
------------------------

Maintainers:
  xxxxx (http://drupal.org/user/xxxx)
Requires - Drupal 7
License - GPL (see LICENSE)


Overview:
--------

xxxxxx
yyyyyy

* jQuery Autopager plugin v1.0.0 - https://code.google.com/p/jquery-autopager/


Features:
---------

* xxxxx
* yyyyy


Installation:
------------

1. Download and unpack the Libraries module directory in your modules folder
   (this will usually be "sites/all/modules/").
   Link: http://drupal.org/project/libraries
2. Download and unpack the Views Infinite Scroll module directory in your modules folder
   (this will usually be "sites/all/modules/").
3. Download and unpack the jQuery Autopager plugin v1.0.0 in "sites/all/libraries".
    Make sure the path to the plugin file becomes:
    "sites/all/libraries/autopager/jquery.autopager-1.0.0.js"
   Link: https://code.google.com/p/jquery-autopager/downloads/list
   Drush users can use the command "drush dl-autopager".
4. Go to "Administer" -> "Modules" and enable the Views Infinite Scroll module.

Comments

lpalgarvio’s picture

lpalgarvio’s picture

Issue summary: View changes

fix

lpalgarvio’s picture

someone provided a readme patch here
https://drupal.org/node/1370738

mgifford’s picture

Component: Documentation » Code
Issue summary: View changes
Status: Active » Closed (duplicate)
Related issues: +#1370738: Where to place plugin

Ok, then we can close this one.