Why so many readmes?

Lucas Taylor avatarLucas Taylor created an issue

We've got:

  • dbf.README
  • dbf.md
  • dbf.WHATSNEW
  • README.md

dbf.README looks to be a general intro while dbf.md looks to be more of an api reference.

README.md was created from dbf.README to provide a Bitbucket overview page and clarify that this repo is UNOFFICIAL.

Suggested actions:

  • Remove dbf.README and rely on README.md as the general intro
  • Rename dbf.md to API.md
  • Rename dbf.WHATSNEW to CHANGELOG.md

*.md will be rendered automatically by Bitbucket, so that's a nice bonus.

Comments (4)

  1. stoneleaf

    Because I have dbf as a module instead of a package, I needed to have the files clearly belong to dbf since they would be sitting in .../site-packages/ along with other possible READMEs.

  2. Log in to comment
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.