README.md 4.21 KB
Newer Older
1
<a href="#readme"></a>
2 3 4 5 6 7 8

<p align="center">
  <img src="http://magit.vc/img/L.png" align="left">
  <img src="http://magit.vc/img/R.png" align="right">
  <b>
    When something doesn't work as expected, then please first consult the
    <a href="http://magit.vc/manual/magit/FAQ.html">FAQ</a> and ask a
Jonas Bernoulli's avatar
Jonas Bernoulli committed
9
	search engine.   If that doesn't solve your problem, then please ask for help on the
Jonas Bernoulli's avatar
Jonas Bernoulli committed
10 11
    <a href="http://emacs.stackexchange.com/questions/tagged/magit">Emacs Stackexchange site</a>
	or the <a href="https://gitter.im/magit/magit">Gitter chat</a>.
12 13 14 15
  </b>
</p>
***

16 17 18 19 20 21 22 23 24 25 26 27 28 29
<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>
***
30

31 32 33 34 35
<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
Jonas Bernoulli's avatar
Jonas Bernoulli committed
36
  (yet) claim that Magit wraps and improves upon each and every Git
37 38 39 40
  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.
Jonas Bernoulli's avatar
Jonas Bernoulli committed
41
  <a href="http://magit.vc/about.html">(more)</a>
42 43 44 45
</p>
***

<p align="center">
46 47 48 49
  <b>
    Please consider supporting development by making a
    <a href="http://magit.vc/donations.html">donation</a>.
  </b>
50 51 52 53 54 55
</p>
***

Support
=======

Jonas Bernoulli's avatar
Jonas Bernoulli committed
56 57
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
58
the search box at the top of that page to find older related issues.
Jonas Bernoulli's avatar
Jonas Bernoulli committed
59
You should also consult the [manual][manual] and ask a general-purpose
60 61
search engine.

Jonas Bernoulli's avatar
Jonas Bernoulli committed
62 63 64
If that doesn't answer your question, then ask for help on the
**[Emacs Stackexchange site][forum]**, the [mailing list][list], or
the [Gitter chat][chat].
65

Zach Latta's avatar
Zach Latta committed
66
**Please do NOT use the GitHub issue tracker for support requests.**
67 68 69
**We only use it for feature requests and bug reports.**

Contributing
70 71
============

72 73
To report bugs and suggest new feature use the
[issue tracker][issues].  If you have some code which you would like
David L. Rager's avatar
David L. Rager committed
74
to be merged, then open a [pull request][pulls]. Please also see
75
[CONTRIBUTING.md][contrib].
76

77 78
Acknowledgments
===============
79

80 81 82
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
83
[Nicolas Dudebout][nicolas], [Peter J. Weisberg][peter],
84
[Phil Jackson][phil], [Rémi Vanicat][remi], and [Yann Hodique][yann].
85
Many more people have [contributed code][authors] and suggested
86 87 88 89
features.

Thanks to all of you, may (the history of) the source be with you!

90 91 92
***
[![Build Status](https://travis-ci.org/magit/magit.svg?branch=master)](https://travis-ci.org/magit/magit)

93
[contrib]: https://github.com/magit/magit/blob/master/CONTRIBUTING.md
94 95
[issues]:  https://github.com/magit/magit/issues
[pulls]:   https://github.com/magit/magit/pulls
96

97 98 99
[authors]: http://magit.vc/stats/authors.html
[faq]:     http://magit.vc/manual/magit/FAQ.html
[manual]:  http://magit.vc/manual
100

101 102 103
[chat]:    https://gitter.im/magit/magit
[forum]:   http://emacs.stackexchange.com/questions/tagged/magit
[list]:    https://groups.google.com/forum/?fromgroups#!forum/magit
104

105
[jonas]:   http://emacsair.me
106
[kyle]:    https://github.com/kyleam
107
[marius]:  https://github.com/mvollmer
Jonas Bernoulli's avatar
Jonas Bernoulli committed
108
[nicolas]: http://dudebout.com
109
[noam]:    https://github.com/npostavs
110 111 112
[peter]:   https://github.com/pjweisberg
[phil]:    https://github.com/philjackson
[remi]:    https://github.com/vanicat
113
[yann]:    http://www.hodique.info