Rewrite the README to provide more useful info and include it in the package.

Review Request #10005 — Created June 6, 2018 and submitted

chipx86
Djblets
release-1.0.x
0524fce...
djblets

The new README is based on ReST, allowing us to provide a formatted
version compatible with GitHub and PyPI. The new version provides a
summary of every package, including links to the appropriate code
reference docs, and has sections on version compatibility, installing,
contributing patches, and filing bugs.

This new README is included in all package builds, allowing viewers on
PyPI to see it without navigating to the source.

Compiled the README to HTML and viewed the output, checking for broken
links or other noticeable errors.

Built a package and inspected the metadata, ensuring the new description
was included.

  • 0
  • 0
  • 2
  • 0
  • 2
Description From Last Updated
david
  1. 
      
  2. README.rst (Diff revision 1)
     
     

    Trailing whitespace

  3. README.rst (Diff revision 1)
     
     

    Period at the end?

  4. 
      
chipx86
david
  1. Ship It!
  2. 
      
chipx86
Review request changed

Status: Closed (submitted)

Change Summary:

Pushed to release-1.0.x (69d9c3b)
Loading...