README.md (6744B)
1 <div align="center"><img src="https://magit.vc/assets/magit-168x200px.png"/></div> 2 <h2 align="center">A Git Porcelain inside Emacs</h2> 3 <p align="center"> 4 <a href="https://magit.vc"><b>homepage</b></a> | 5 <a href="https://magit.vc/manual"><b>manual</b></a> | 6 <a href="https://magit.vc/manual/magit/FAQ.html"><b>faq</b></a> | 7 <a href="https://github.com/magit/magit/wiki"><b>wiki</b></a> | 8 <a href="https://groups.google.com/forum/?fromgroups#!forum/magit"><b>mailing list</b></a> | 9 <a href="https://emacs.stackexchange.com/questions/tagged/magit"><b>forum</b></a> | 10 <a href="https://twitter.com/magit_emacs"><b>news</b></a> 11 </p> 12 <hr> 13 14 <p align="justify"> 15 Magit is an interface to the version control system 16 <a href="https://git-scm.com">Git</a>, implemented as an 17 <a href="https://www.gnu.org/software/emacs">Emacs</a> package. 18 Magit aspires to be a complete Git porcelain. While we cannot 19 (yet) claim that Magit wraps and improves upon each and every Git 20 command, it is complete enough to allow even experienced Git users 21 to perform almost all of their daily version control tasks directly 22 from within Emacs. While many fine Git clients exist, only Magit 23 and Git itself deserve to be called porcelains. 24 </p> 25 <hr> 26 27 <div align="center"> 28 Keeping its users <a href= "https://magit.vc/quotes">this excited</a> is 29 <a href="https://magit.vc/stats/authors.html#cumulated_added_lines_of_code_per_author"> 30 a lot of work 31 </a>. 32 If Magit makes you <br> more productive too, 33 then <b>please consider making a donation</b>. 34 </div> 35 <div align="center"> 36 <em>Thank you! — Jonas Bernoulli</em> 37 </div> 38 <br> 39 <div align="center"> 40 <a href="https://github.com/sponsors/tarsius"> 41 <img title="Donate using Github Sponsors" 42 alt="Donate using Github Sponsors" 43 src="https://magit.vc/assets/github-sponsors-50px.png"></a> 44 45 <a href="https://magit.vc/donate/#iban"> 46 <img title="Donate using IBAN" 47 alt="Donate using IBAN" 48 src="https://magit.vc/assets/iban-50px.png"></a> 49 50 <a href="https://magit.vc/donate/#zelle"> 51 <img title="Donate using Zelle (USA bank transfer)" 52 alt="Donate using Zelle (USA bank transfer)" 53 src="https://magit.vc/assets/zelle-50px.png"></a> 54 55 <a href="https://www.paypal.me/JonasBernoulli/20"> 56 <img title="Donate using PayPal" 57 alt="Donate using PayPal" 58 src="https://magit.vc/assets/paypal.png"></a> 59 </div> 60 <br> 61 <div align="center"> 62 Some alternative donation methods are <a href="https://magit.vc/donate">available</a>. 63 </div> 64 <hr> 65 66 Getting Started 67 =============== 68 69 If you are new to Magit, then either one of the following two 70 articles should help understanding how it differs from other Git 71 clients. 72 73 - [Visual Magit walk-through](https://emacsair.me/2017/09/01/magit-walk-through) 74 75 If you are completely new to Magit, then this article is a good 76 visual introduction. 77 78 Almost everything that you see in Magit can be acted on by pressing 79 some key, but that's not obvious from just seeing how Magit looks. 80 The screenshots and accompanying text of this article explain how to 81 perform a variety of actions on Magit's output. 82 83 - [Magit, the magical Git interface](https://emacsair.me/2017/09/01/the-magical-git-interface) 84 85 Magit differs significantly from other Git interfaces, and its 86 advantages are not immediately obvious simply from looking at a few 87 screenshots as presented in the preceding article. 88 89 This article discusses Magit's properties in somewhat more abstract 90 terms. 91 92 Support 93 ======= 94 95 When something doesn't work as expected then please first see the 96 [FAQ][faq]. Then also try the list of [open issues][issues] and use 97 the search box at the top of that page to find older related issues. 98 You should also consult the [manual][manual] and ask a general-purpose 99 search engine. 100 101 If that doesn't answer your question, then ask for help on the 102 **[Emacs Stackexchange site][forum]** or the [mailing list][list]. 103 We only use the GitHub issue tracker for feature requests and bug 104 reports, so please don't ask for help there. 105 106 Contributing 107 ============ 108 109 To report bugs and suggest new feature use the 110 [issue tracker][issues]. If you have some code which you would like 111 to be merged, then open a [pull request][pulls]. Please also see 112 [CONTRIBUTING.md][contrib]. 113 114 Acknowledgments 115 =============== 116 117 Magit was started by [Marius Vollmer][marius], and is now maintained 118 by [Jonas Bernoulli][jonas], [Kyle Meyer][kyle], and 119 [Noam Postavsky][noam]. Other former maintainers are 120 [Nicolas Dudebout][nicolas], [Peter J. Weisberg][peter], 121 [Phil Jackson][phil], [Rémi Vanicat][remi], and [Yann Hodique][yann]. 122 Many more people have [contributed code][authors] and suggested 123 features. 124 125 Over the years a lot of people supported development financially, 126 including the [1987 backers][backers] of the 2017 crowdfunding 127 campaign. 128 129 Thanks to all of you, may (the history of) the source be with you! 130 131 *** 132 [](https://xkcd.com/859) 133 [](http://www.gnu.org/licenses/gpl-3.0.txt) 134 [](https://github.com/magit/magit/actions) 135 [](https://melpa.org/#/magit) 136 [](https://stable.melpa.org/#/magit) 137 [](https://magit.vc/manual/magit) 138 [](https://magit.vc/stats/authors.html#commits_per_author) 139 [](https://en.wikipedia.org/wiki/Browser_wars) 140 141 142 [backers]: https://github.com/magit/magit/blob/master/Documentation/BACKERS.md 143 [contrib]: https://github.com/magit/magit/blob/master/.github/CONTRIBUTING.md 144 [issues]: https://github.com/magit/magit/issues 145 [pulls]: https://github.com/magit/magit/pulls 146 147 [authors]: https://magit.vc/stats/authors.html 148 [faq]: https://magit.vc/manual/magit/FAQ.html 149 [manual]: https://magit.vc/manual 150 151 [forum]: https://emacs.stackexchange.com/questions/tagged/magit 152 [list]: https://groups.google.com/forum/?fromgroups#!forum/magit 153 154 [jonas]: https://emacsair.me 155 [kyle]: https://github.com/kyleam 156 [marius]: https://github.com/mvollmer 157 [nicolas]: http://dudebout.com 158 [noam]: https://github.com/npostavs 159 [peter]: https://github.com/pjweisberg 160 [phil]: https://github.com/philjackson 161 [remi]: https://github.com/vanicat 162 [yann]: http://www.hodique.info