Fix missing/multiple README.txt problem

Bug #433583 reported by Paul Everitt
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
KARL3
Fix Released
Medium
Shane Hathaway

Bug Description

Mike noted that getting a checkout of OSI's buildout doesn't get a README.txt into the root. Whereas the other 3, do.

Also, it will be a bit unfortunate if we have to maintain different READMEs for every customization.

As part of this task:

- Make sure, at a minimum, the OSI checkout has a README.

- Preferably, come up with a better long-term solution. Perhaps there should be a skeletal README in each checkout that says "look in src/karl/karl/README.txt" or something.

Revision history for this message
Paul Everitt (paul-agendaless) wrote :

Moving to a more accurate milestone. Chris, what is the status on this?

Changed in karl3:
milestone: m33 → m35
Revision history for this message
Paul Everitt (paul-agendaless) wrote :

Shane will work on this. Along the way he will:

- Find the old, well-written README.txt and get it into the "right" place (likely, under src/karl)

- Ensure that getting a buildout results in a README.txt at the root (above etc, src, etc.) that tells people to look in the right place for the installation instructions

- Remove any decoys in src/osi/README.txt, src/eurasia, etc.

- Remove the generated decoy Sphinx docs in src/osi/docs (and any other customization packages)

Changed in karl3:
assignee: Chris Rossi (chris-archimedeanco) → Shane Hathaway (shane-hathawaymix)
Revision history for this message
Shane Hathaway (shane-hathawaymix) wrote :

README.txt is now in a rational state and the fake documentation is gone.

Changed in karl3:
status: New → Fix Committed
Changed in karl3:
status: Fix Committed → Fix Released
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.