Summary

Rewrite the README and part of the introduction to the docs.

Review Request #11123 — Created Aug. 5, 2020 and submitted Aug. 5, 2020, 11:24 p.m.

Information

Owner

chipx86

Repository

Django Evolution

Branch

master

Bugs

Depends On

Reviewers

Groups

django-evolution

People

Description

The Django Evolution README was horribly out-of-date. It didn't make a

good case for itself in the modern world, and gave the impression the

project hasn't been touched in many years.
This change completely rewrites the README. It's now in

ReStructuredText, instead of Markdown, and included as package metadata.

The new content talks about where Django Evolution is useful and touches

upon the compatibility with Django's migrations. It includes updated

compatibility information and a link to the (upcoming) public docs, plus

a blurb about its usage in Review Board.

Testing Done

Checked the rendered README and the new docs.
Built a package and verified the presence of the README in the metadata.

Commits

Summary	ID
Rewrite the README and part of the introduction to the docs. The Django Evolution README was horribly out-of-date. It didn't make a good case for itself in the modern world, and gave the impression the project hasn't been touched in many years. This change completely rewrites the README. It's now in ReStructuredText, instead of Markdown, and included as package metadata. The new content talks about where Django Evolution is useful and touches upon the compatibility with Django's migrations. It includes updated compatibility information and a link to the (upcoming) public docs, plus a blurb about its usage in Review Board.	ed735a3b66d4d6d43f788036c57e2174f810b8ab

Summary

Rewrite the README and part of the introduction to the docs.

The Django Evolution README was horribly out-of-date. It didn't make a good case for itself in the modern world, and gave the impression the project hasn't been touched in many years. This change completely rewrites the README. It's now in ReStructuredText, instead of Markdown, and included as package metadata. The new content talks about where Django Evolution is useful and touches upon the compatibility with Django's migrations. It includes updated compatibility information and a link to the (upcoming) public docs, plus a blurb about its usage in Review Board.

ed735a3b66d4d6d43f788036c57e2174f810b8ab

flake8 passed.

JSHint passed.

Ship it!

```
Ship It!
```

Status:: Completed
Change Summary:: Pushed to master (72a5fa7)