You'll note that in the README.txt file, the first link labeled "Superfish library" points to the Superfish project page, as opposed to where the Superfish library files actually are.
For someone who has already installed and used Superfish 50 times, they might think "well, technically, there IS a link to the Superfish library within the project page, so it's just one more link."
But for a busy developer who's never installed it before, they wouldn't know that it requires BOTH a set of js files in the /sites/all/libraries/superfish folder AND a set of module files in /sites/all/modules/superfish. So that also should be clearer on the project page. For requirements, it lists only the library, but NOT the module. If both were listed, then it would be much clearer.
To summarize:
a. Update the README.txt file in the module to point to the library files URL instead of the Drupal project page.
b. Update the description on the project page to make it super clear that both a set of library files AND a set of module files are required.
Comment | File | Size | Author |
---|---|---|---|
#3 | superfish-library-link-in-readme-2644322-3.patch | 1.17 KB | jwilson3 |
superfish-instructions-readme.png | 19.05 KB | jeromewiley |
Comments
Comment #2
jeromewiley CreditAttribution: jeromewiley commentedComment #3
jwilson3There is a link already in the readme, if you go down a bit further in the installation instructions section:
However, it is a valid point that the link in the readme doesn't match the link on the project page.
Here is a patch that fixes the link, and adds the jquery update dependency to the requirements section. Basically breaking the 7.x README file inline with the project page.
Comment #4
jwilson3Comment #6
mehrpadin CreditAttribution: mehrpadin commentedHey everybody,
Patch applied, thank you.