Summary

Add a new README for the Review Board codebase.

Review Request #7382 — Created June 5, 2015 and submitted June 5, 2015, 3:33 p.m.

Information

Owner

chipx86

Repository

Review Board

Branch

release-2.0.x

Bugs

Depends On

Commit

4be710f...

Reviewers

Groups

reviewboard

People

Description

Our old README for Review Board was pretty small and useless. Not a
great landing experience for users going to the project on GitHub. This
new Markdown-formatted README covers the history and purpose of
Review Board, points to the installation pages, documentation, Power
Pack, RBTools, support information, Happy Users page, and basic
information on how to contribute to the project.

Testing Done

Viewed this in Marked (a Markdown renderer that can render as GitHub would).
Things looked fine.

Issues

Description	From	Last Updated
"feature them on Happy Users Page"? Maybe add a "the"	david	June 5, 2015, 1:16 p.m.
"feature them up on ..." is pretty weird. How about getting rid of "up"?	david	June 5, 2015, 12:46 p.m.

Tool: PEP8 Style Checker
Ignored Files:
    README
    README.md



Tool: Pyflakes
Ignored Files:
    README
    README.md

Ship it!

README.md (Diff revision 1)

The issue has been resolved. Show all issues

"feature them up on ..." is pretty weird. How about getting rid of "up"?

Change Summary:


Fixed up a weird-sounding sentence.
Added a section for related projects (RBTools, Djblets, etc.).

Commit:

b529e6dd0bd58721814f93677ddddf5a4c5794f5

710964845de30ba6f0b39e92066b9d9f6f4465f4

Diff:

Revision 2 (+170 -13)

Show changes

	README
	README.md

Tool: PEP8 Style Checker
Ignored Files:
    README
    README.md



Tool: Pyflakes
Ignored Files:
    README
    README.md

README.md (Diff revisions 1 - 2)

The issue has been resolved. Show all issues

"feature them on Happy Users Page"? Maybe add a "the"

chipx86 June 5, 2015, 1:15 p.m.

Can you tell I wrote this section while half asleep?

Change Summary:

"Add the "the". It's cleaner."

Commit:

710964845de30ba6f0b39e92066b9d9f6f4465f4

4be710f40b81e97af9d0fa8ac4bdfbba8c5c7104

Diff:

Revision 3 (+170 -13)

Show changes

	README
	README.md

Tool: PEP8 Style Checker
Ignored Files:
    README
    README.md



Tool: Pyflakes
Ignored Files:
    README
    README.md

Ship it!

```
Ship It!
```

Status:: Completed
Change Summary:: Pushed to release-2.0.x (6a7a11d)