Summary

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

Review Request #10005 — Created June 6, 2018 and submitted June 14, 2018, 8:08 p.m.

Information

Owner

chipx86

Repository

Djblets

Branch

release-1.0.x

Bugs

Depends On

Commit

0524fce...

Reviewers

Groups

djblets

People

Description

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.

Testing Done

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.

Issues

Description	From	Last Updated
Trailing whitespace	david	June 14, 2018, 5:13 p.m.
Period at the end?	david	June 14, 2018, 5:13 p.m.

flake8 passed.

JSHint passed.

README.rst (Diff revision 1)
The issue has been resolved. Show all issues
```
Trailing whitespace
```
README.rst (Diff revision 1)
The issue has been resolved. Show all issues
```
Period at the end?
```

Change Summary:

Fixed trailing whitespace and a missing period.

Commit:

aba5502694cd2839b9dd4de1ce2dd4d68ab4fc31

0524fcecd8ddb04bf996646509554957ce1e163c

Diff:

Revision 2 (+261 -83)

Show changes

	README
	README.rst
	setup.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Ship it!

```
Ship It!
```

Status:: Completed
Change Summary:: Pushed to release-1.0.x (69d9c3b)

README.rst (Diff revision 1)

README.rst (Diff revision 1)