search

backdrop-contrib / footnotes

Add automatically numbered footnotes to your content.
GNU General Public License v2.0
2 stars 2 forks source link

Improve README.md #6

Closed olafgrabienski closed 5 years ago

olafgrabienski commented 5 years ago

When the module works, the README.md should describe the basic functionality and mention the (working) sub modules. The sub modules can then be described more detailed in the Wiki.

Reminder: Compare the README.md with various README.txt files of the Drupal version.

olafgrabienski commented 5 years ago

To do as well: mention people who helped porting the module

olafgrabienski commented 5 years ago

Related: #10 (footnotes_field: Document node context limitation)

olafgrabienski commented 5 years ago

Related: #14 (Angle brackets), task: remove angle bracket references, or at least don't suggest to use them

olafgrabienski commented 5 years ago

The sub modules can then be described more detailed in the Wiki.

I decided to mention the submodules in the README instead of creating Wiki.

olafgrabienski commented 5 years ago

To avoid confusion due to different README files, I'll delete the README.txt of the Drupal module.

olafgrabienski commented 5 years ago

I've made a proofreading of the README.md, PR upcoming.