Opened 6 years ago

Last modified 5 years ago

#133 closed defect

[Document projects consistently] Add a README.md to the sitescripts repository — at Version 3

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

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

Description (last modified by fhd)

Background

See #128.

What to change

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 (3)

comment:1 Changed 6 years ago by fhd

  • Cc trev added

Wladimir, what do you think about the approach above? The alternative would probably be to have everything module-related in the top-level README.md as well, but that could get kinda big.

comment:2 Changed 6 years ago by fhd

  • Blocking 128 added

comment:3 Changed 6 years ago by fhd

  • Description modified (diff)
  • Status changed from new to accepted
  • Summary changed from Add a README.md to the sitescripts repository to [Document projects consistently] Add a README.md to the sitescripts repository
Note: See TracTickets for help on using tickets.