Opened 6 years ago

Last modified 5 years ago

#133 closed defect

Add a README.md to the sitescripts repository — at Initial Version

Reported by: fhd Assignee:
Priority: P4 Milestone:
Module: Sitescripts Keywords:
Cc: trev, sebastian Blocked By:
Blocking: Platform: Unknown / Cross platform
Ready: yes Confidential: no
Tester: Unknown Verified working: no
Review URL(s):

https://codereview.adblockplus.org/29328521/

Description

See #128.

Since sitescripts consists of several unrelated modules, the top-level README.md should just cover the basics, e.g. multiplexer.py.

It would also make sense to add individual README.mds to the modules under sitescripts/, e.g. as with sitescripts/crawler.

The top-level README.md probably shouldn't list all the modules, pretty likely to get out of sync. Instead it could say that there are several different modules under sitescripts/ and mention that some have their own README.md.

Change History (0)

Note: See TracTickets for help on using tickets.