aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJonas Bernoulli <jonas@bernoul.li>2022-03-26 16:29:57 +0100
committerJonas Bernoulli <jonas@bernoul.li>2022-03-26 16:29:57 +0100
commitb1702991eec2c068d282fc2f1bd665726a14e10d (patch)
tree325dc3d17804a983f8b0792e3e605eb97dce59ec /README.md
parent9a3b8517057a7021d282a0faacba653da2756f7e (diff)
Update README.md and CONTRIBUTING.md
Favor links over duplicating information and then letting it get out-of-date. Of course links may break too, so fix those too.
Diffstat (limited to 'README.md')
-rw-r--r--README.md101
1 files changed, 39 insertions, 62 deletions
diff --git a/README.md b/README.md
index ea788e1..9a2629e 100644
--- a/README.md
+++ b/README.md
@@ -5,8 +5,6 @@
<a href="https://magit.vc/manual"><b>manual</b></a> |
<a href="https://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="https://emacs.stackexchange.com/questions/tagged/magit"><b>forum</b></a> |
<a href="https://twitter.com/magit_emacs"><b>news</b></a>
</p>
<hr>
@@ -26,7 +24,7 @@
<div align="center">
Keeping its users <a href= "https://magit.vc/quotes">this excited</a> is
- <a href="https://magit.vc/stats/authors.html#cumulated_added_lines_of_code_per_author">
+ <a href="https://magit.vc/stats/magit/authors.html#cumulated_added_lines_of_code_per_author">
a lot of work
</a>.
If Magit makes you <br> more productive too,
@@ -63,68 +61,59 @@
</div>
<hr>
-Getting Started
-===============
+### Getting Started
If you are new to Magit, then either one of the following two
articles should help understanding how it differs from other Git
clients.
-- [Visual Magit walk-through](https://emacsair.me/2017/09/01/magit-walk-through)
+#### [Visual Magit walk-through](https://emacsair.me/2017/09/01/magit-walk-through)
- If you are completely new to Magit, then this article is a good
- visual introduction.
+If you are completely new to Magit, then this article is a good
+visual introduction.
- Almost everything that you see in Magit can be acted on by pressing
- some key, but that's not obvious from just seeing how Magit looks.
- The screenshots and accompanying text of this article explain how to
- perform a variety of actions on Magit's output.
+Almost everything that you see in Magit can be acted on by pressing
+some key, but that's not obvious from just seeing how Magit looks.
+The screenshots and accompanying text of this article explain how to
+perform a variety of actions on Magit's output.
-- [Magit, the magical Git interface](https://emacsair.me/2017/09/01/the-magical-git-interface)
+#### [Magit, the magical Git interface](https://emacsair.me/2017/09/01/the-magical-git-interface)
- Magit differs significantly from other Git interfaces, and its
- advantages are not immediately obvious simply from looking at a few
- screenshots as presented in the preceding article.
+Magit differs significantly from other Git interfaces, and its
+advantages are not immediately obvious simply from looking at a few
+screenshots as presented in the preceding article.
- This article discusses Magit's properties in somewhat more abstract
- terms.
+This article discusses Magit's properties in somewhat more abstract
+terms.
-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] and ask a general-purpose
-search engine.
+***
+### Support and Contributing
-If that doesn't answer your question, then ask for help on the
-**[Emacs Stackexchange site][forum]** or the [mailing list][list].
-We only use the GitHub issue tracker for feature requests and bug
-reports, so please don't ask for help there.
+Magit has many users and very few maintainers, so we kindly ask to read
+the appropriate guidelines before getting in contact. &mdash; Thanks!
-Contributing
-============
+- 🆘 [How to ask for help](https://github.com/magit/magit/discussions/4630)
+- 🪳 [How to report a bug](https://github.com/magit/magit/wiki/How-to-report-a-bug)
+- 💡 [How to suggest a feature](https://github.com/magit/magit/discussions/4631)
+- 🏗️ [Pull request guidelines](https://github.com/magit/magit/wiki/Pull-request-guidelines)
+- ℹ️ [FAQ](https://magit.vc/manual/magit/FAQ.html)
+- ℹ️ [Manual](https://magit.vc/manual/magit)
-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 request][pulls]. Please also see
-[CONTRIBUTING.md][contrib].
+TL;DR We now use discussions for feature requests (not issues) and prefer
+if you ask the community for support instead of the overworked maintainers.
-Acknowledgments
-===============
+Please also consider to contribute by supporting other users or by making
+a [monetary donation](https://magit.vc/donate). &mdash; Thanks!
-Magit was started by [Marius Vollmer][marius], and is now maintained
-by [Jonas Bernoulli][jonas], [Kyle Meyer][kyle], and
-[Noam Postavsky][noam]. 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][authors] and suggested
-features.
+***
+### Acknowledgments
-Over the years a lot of people supported development financially,
-including the [1987 backers][backers] of the 2017 crowdfunding
-campaign.
+Magit was started by [Marius Vollmer][marius], and is now maintained by
+[Jonas Bernoulli][jonas] and [Kyle Meyer][kyle]. Former maintainers are
+[Nicolas Dudebout][nicolas], [Noam Postavsky][noam],
+[Peter J. Weisberg][peter], [Phil Jackson][phil], [Rémi Vanicat][remi] and
+[Yann Hodique][yann]. Many more people have [contributed code][authors],
+suggested features or made monetary contributions.
Thanks to all of you, may (the history of) the source be with you!
@@ -136,24 +125,12 @@ Thanks to all of you, may (the history of) the source be with you!
[![Melpa](https://melpa.org/packages/magit-badge.svg)](https://melpa.org/#/magit)
[![Melpa Stable](https://stable.melpa.org/packages/magit-badge.svg)](https://stable.melpa.org/#/magit)
[![Eierlegende Wollmilchsau](https://img.shields.io/badge/eierlegende-Wollmilchsau-green.svg)](https://magit.vc/manual/magit)
-[![Swiss Made](https://img.shields.io/badge/swiss-made-red.svg?colorA=E11A27&colorB=555555)](https://magit.vc/stats/authors.html#commits_per_author)
[![Netscape](https://magit.vc/assets/netscape-20px.png)](https://en.wikipedia.org/wiki/Browser_wars)
-[backers]: https://github.com/magit/magit/blob/master/Documentation/BACKERS.md
-[contrib]: https://github.com/magit/magit/blob/master/.github/CONTRIBUTING.md
-[issues]: https://github.com/magit/magit/issues
-[pulls]: https://github.com/magit/magit/pulls
-
-[authors]: https://magit.vc/stats/authors.html
-[faq]: https://magit.vc/manual/magit/FAQ.html
-[manual]: https://magit.vc/manual
-
-[forum]: https://emacs.stackexchange.com/questions/tagged/magit
-[list]: https://groups.google.com/forum/?fromgroups#!forum/magit
-
+[authors]: https://magit.vc/stats/magit/authors.html
[jonas]: https://emacsair.me
-[kyle]: https://github.com/kyleam
+[kyle]: https://kyleam.com
[marius]: https://github.com/mvollmer
[nicolas]: http://dudebout.com
[noam]: https://github.com/npostavs