aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJonas Bernoulli <jonas@bernoul.li>2015-06-23 19:18:00 +0200
committerJonas Bernoulli <jonas@bernoul.li>2015-06-23 19:18:00 +0200
commit600c091c5ea2e2f423210265115628ad56c01593 (patch)
treec30838ab4d1523fe5fb1ff9d8e43b41f25dccf22
parenta2f8a414eadb43f9f445f9dbf96082832a7582cf (diff)
prepare README.md and CONTRIBUTING.md for release
-rw-r--r--CONTRIBUTING.md56
-rw-r--r--README.md167
2 files changed, 132 insertions, 91 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 4621b48..8152702 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,27 +1,41 @@
-Magit is currently in feature freeze. Please keep that in mind
-when suggesting new features or submitting code contributions.
+Getting help
+============
-No new features will be implemented on the `master` branch, even
-if they are "obviously not going to cause any problems" (this has
-frequently turned out not to be true after all). Even for bugfixes
-the threshold is fairly high now; if fixing a bug which has existed
-for years seems risky, then it won't be fixed now.
+**When something doesn't work as expected then please first see the
+[FAQ][faq].** Then also try the list of [open issues][issues] and use
+the search box at the top of that page to find older related issues.
+You should also consult the [manual][manual] ask a general-purpose
+search engine.
-Very few new features will be implemented on the `next` branch.
-Basically only features that help *fixing* existing features might
-be implemented despite the feature freeze.
+If everything else fails then ask for help on the
+**[Emacs Stackexchange site][forum]**, the
+[mailing list][list], or the
+[Gitter chat][chat].
-If you feel that your issue or new feature is important enough to
-violate the above restrictions, then please explicitly note that you
-have read this and explain in your initial post why you feel an
-exception should be made. That way I at least do not have to repeat
-the above yet once more.
+Reporting issues and suggesting features
+========================================
-Please also consider whether your feature really is important enough
-that implementing it now is justification enough to further delay the
-release of the many new and many more improved features in `next`.
+To report bugs and suggest new feature use the [issue tracker][issues].
-Also see the [Roadmap toward 2.1.0](https://github.com/magit/magit/issues/1645).
+Never use the phrase "at the very least".
-Report issues [here](https://github.com/magit/magit/issues),
-and open pull requests [here](https://github.com/magit/magit/pulls).
+Code contributions
+==================
+
+If you have some code which you would like to be merged, then open a
+[pull requests][pulls]. Please create atomic commits with descriptive
+commit messages.
+
+Donations
+=========
+
+Please also consider to contribute by making a
+[monetary donation][donation].
+
+
+[chat]: https://gitter.im/magit/magit
+[donations]: http://magit.vc/donations.html
+[faq]: http://magit.vc/manual/magit/FAQ.html
+[forum]: http://emacs.stackexchange.com/questions/tagged/magit
+[list]: https://groups.google.com/forum/?fromgroups#!forum/magit
+[manual]: http://magit.vc/manual
diff --git a/README.md b/README.md
index 8da182f..0f78208 100644
--- a/README.md
+++ b/README.md
@@ -1,92 +1,119 @@
-[![Support](https://img.shields.io/badge/get-help-blue.svg)](#getting-help)
-[![Gitter](https://badges.gitter.im/Join%20Chat.svg)][gitter]
-[![Build Status](https://travis-ci.org/magit/magit.svg?branch=master)](https://travis-ci.org/magit/magit)
-[![Gratipay](http://img.shields.io/gratipay/magit.png)](https://www.gratipay.com/magit)
-[![Donations](https://img.shields.io/badge/please-donate-ff69b4.svg)][donations]
-
-It's Magit! A Git Porcelain inside Emacs
-=========================================
-
-**The Magit wiki contains a list of [FREQUENTLY ASKED QUESTIONS][faq],
-please do consult it.**
-
-**Magit is in [FEATURE FREEZE][roadmap], keep that in mind when making
-feature requests.**
-
-Magit is an interface to the version control system [Git][git],
-implemented as an [Emacs][emacs] package.
-
-Unlike the [VC][vc] package which is part of Emacs and strives to
-provide a unified interface to various version control systems, Magit
-only supports Git and can therefore better take advantage of its
-native features.
-
-Installation
-============
-
-*Magit 2.0.50 requires at least GNU Emacs 24.4 and Git 1.9.4.*
-
-Instructions on how to install the `2.0.50` pre-release can be found
-[here](http://magit.vc/manual/magit/Installation.html). `2.1.0` will
-be released on the 1th of July.
-
-Instructions on how to install the `1.4.2` release can be found
-[here](https://github.com/magit/magit/wiki/Installation).
-
-Getting Help
+<a href="#readme"></a>
+<p align="center"><img src="http://magit.vc/img/magit.png"/></p>
+<h1 align="center">It's Magit!</h1>
+<h2 align="center">A Git Porcelain inside Emacs</h2>
+<p align="center">
+ <a href="http://magit.vc"><b>homepage</b></a> |
+ <a href="http://magit.vc/manual"><b>manual</b></a> |
+ <a href="http://magit.vc/manual/magit/FAQ.html"><b>faq</b></a> |
+ <a href="https://github.com/magit/magit/wiki"><b>wiki</b></a> |
+ <a href="https://groups.google.com/forum/?fromgroups#!forum/magit"><b>mailing list</b></a> |
+ <a href="http://emacs.stackexchange.com/questions/tagged/magit"><b>forum</b></a> |
+ <a href="https://gitter.im/magit/magit"><b>chat</b></a> |
+ <a href="https://twitter.com/magit_emacs"><b>news</b></a>
+</p>
+
+***
+<p align="justify">
+ Magit is an interface to the version control system
+ <a href="http://git-scm.com">Git</a>, implemented as an
+ <a href="http://www.gnu.org/software/emacs">Emacs</a> package.
+ Magit aspires to be a complete Git porcelain. While we cannot
+ (yet) claim, that Magit wraps and improves upon each and every Git
+ command, it is complete enough to allow even experienced Git users
+ to perform almost all of their daily version control tasks directly
+ from within Emacs. While many fine Git clients exist, only Magit
+ and Git itself deserve to be called porcelains.
+</p>
+***
+
+<p align="center">
+ Please consider supporting development by making a
+ <a href="http://magit.vc/donations.html">donation</a>.
+</p>
+***
+
+Magit 2.1.0 will be released on the 1th of July
+===============================================
+
+- To install the soon to be obsolete `1.4.2` release, follow
+ [these](https://github.com/magit/magit/wiki/Installation) old
+ instructions.
+
+- To install the `2.0.50` pre-release now, follow [these](install)
+ instructions. Note that until `2.1.0` has been released you have
+ to install directly from the development repository.
+
+- If you are the maintainer of a package that depends on Magit, then
+ please start using `2.0.50` now and try to adapt your package before
+ the 1th of July. Thanks.
+
+- For more information see [this][roadmap] issue.
+
+Before you install the new version (regardless of whether you install
+the `2.0.50` pre-release now, or the `2.1.0` release once that has
+arrived) you have to **first uninstall `1.4.0`**. See [this][update]
+page for more information.
+
+Support
+=======
+
+**When something doesn't work as expected then please first see the
+[FAQ][faq].** Then also try the list of [open issues][issues] and use
+the search box at the top of that page to find older related issues.
+You should also consult the [manual][manual] ask a general-purpose
+search engine.
+
+If everything else fails then ask for help on the
+**[Emacs Stackexchange site][forum]**, the
+[mailing list][list], or the
+[Gitter chat][chat].
+
+**Please do NOT use the Github issue tracker for support requests.**
+**We only use it for feature requests and bug reports.**
+
+Contributing
============
-When something doesn't work as expected please see the [FAQ][faq], and
-the list of [open issues][issues], and use the search box at the top
-of the latter to find older related issues. If everything else fails
-ask for help on the [Magit Gitter channel][gitter], the
-[Emacs Stackexchange][emacsstack] site or the [mailing list][group].
-
-**Please only use the Github issue tracker for feature requests and bug
-reports - not for support requests.**
-
-Contributions
-=============
+To report bugs and suggest new feature use the
+[issue tracker][issues]. If you have some code which you would like
+to be merged, then open a [pull requests][pulls]. Please also see
+[CONTRIBUTING.md][contrib].
-Magit is [hosted on Github][development]. Please contribute by
-reporting bugs and suggesting features on the [issue tracker][issues]
-or by making code contributions using [pull requests][pulls]. Before
-opening a pull request read the brief
-[contribution guidelines][contributing].
-
-Please also consider supporting development by making a
-[monetary donation][donations]. Thank you!
+Acknowledgments
+===============
Magit was started by [Marius Vollmer][marius] and is now maintained
-by [Jonas Bernoulli][jonas]. Other Magitians (former maintainers)
-are [Nicolas Dudebout][nicolas], [Peter J. Weisberg][peter],
+by [Jonas Bernoulli][jonas]. Other former maintainers are
+[Nicolas Dudebout][nicolas], [Peter J. Weisberg][peter],
[Phil Jackson][phil], [Rémi Vanicat][remi], and [Yann Hodique][yann].
-
Many more people have [contributed code][contributors] and suggested
features.
Thanks to all of you, may (the history of) the source be with you!
+***
+[![Build Status](https://travis-ci.org/magit/magit.svg?branch=master)](https://travis-ci.org/magit/magit)
+
-[contributing]: https://github.com/magit/magit/blob/next/CONTRIBUTING.md
-[development]: https://github.com/magit/magit
-[faq]: https://github.com/magit/magit/wiki/FAQ
-[install]: https://github.com/magit/magit/wiki/Installation
-[issues]: https://github.com/magit/magit/issues
-[pulls]: https://github.com/magit/magit/pulls
-[roadmap]: https://github.com/magit/magit/issues/1645
+[contrib]: https://github.com/magit/magit/blob/next/CONTRIBUTING.md
+[issues]: https://github.com/magit/magit/issues
+[pulls]: https://github.com/magit/magit/pulls
+[roadmap]: https://github.com/magit/magit/issues/1645
[contributors]: http://magit.vc/stats/authors.html
[donations]: http://magit.vc/donations.html
-[manual]: http://magit.vc/manual/next
+[faq]: http://magit.vc/manual/magit/FAQ.html
+[install]: http://magit.vc/manual/magit/Installation.html
+[manual]: http://magit.vc/manual
+[update]: http://magit.vc/manual/magit/Updating-from-an-older-release.html
-[emacsstack]: http://emacs.stackexchange.com/questions/tagged/magit
-[gitter]: https://gitter.im/magit/magit
-[group]: https://groups.google.com/forum/?fromgroups#!forum/magit
+[forum]: http://emacs.stackexchange.com/questions/tagged/magit
+[chat]: https://gitter.im/magit/magit
+[list]: https://groups.google.com/forum/?fromgroups#!forum/magit
[emacs]: http://www.gnu.org/software/emacs
[git]: http://git-scm.com
-[vc]: http://www.gnu.org/software/emacs/manual/html_node/emacs/Version-Control.html
[jonas]: http://emacsair.me
[marius]: https://github.com/mvollmer