
Magit is an interface to the version control system [Git], implemented
as an [Emacs] 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.


[Git] <https://git-scm.com>

[Emacs] <https://www.gnu.org/software/emacs>


1 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.


1.1 [Visual Magit walk-through]
───────────────────────────────

  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.


[Visual Magit walk-through]
<https://emacsair.me/2017/09/01/magit-walk-through>


1.2 [Magit, 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.

  This article discusses Magit's properties in somewhat more abstract
  terms.


[Magit, the magical Git interface]
<https://emacsair.me/2017/09/01/the-magical-git-interface>


1.3 Video introductions
───────────────────────

  If you prefer [video] introductions, head over to that page, where
  find a collection of such introductions and other videos about Magit,
  by various creators.


[video] <https://magit.vc/screencasts>


2 Support and Contributing
══════════════════════════

  Magit has many users and very few maintainers, so we kindly ask to
  read the appropriate guidelines before getting in contact. — Thanks!

  Please use your own words.  No stochastic parrots.

  • 🆘 [How to ask for help]
  • 🪳 [How to report a bug]
  • 💡 [How to suggest a feature]
  • 🏗️ [Pull request guidelines]
  • ℹ️ [FAQ]
  • ℹ️ [Manual]

  We use [discussions] (not issues) for feature requests.  Please
  consider asking other users for help, where ever you like to hang out
  with other Emacs users.  not every question can only be answered by
  the maintainer.

  Please consider supporting the maintainer, who makes a living
  maintaining this and other packages, with a [donation]. — Thanks!


[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://docs.magit.vc/magit/FAQ.html>

[Manual] <https://docs.magit.vc/magit>

[discussions] <https://github.com/magit/magit/discussions>

[donation] <https://magit.vc/donate>


3 Acknowledgments
═════════════════

  Magit was started by [Marius Vollmer], and is now maintained by [Jonas
  Bernoulli] and [Kyle Meyer].  Former maintainers are [Nicolas
  Dudebout], [Noam Postavsky], [Peter J. Weisberg], [Phil Jackson],
  [Rémi Vanicat] and [Yann Hodique].  Many more people have [contributed
  code], suggested features or made monetary contributions.


[Marius Vollmer] <https://github.com/mvollmer>

[Jonas Bernoulli] <https://emacsair.me>

[Kyle Meyer] <https://kyleam.com>

[Nicolas Dudebout] <https://github.com/dudebout>

[Noam Postavsky] <https://github.com/npostavs>

[Peter J. Weisberg] <https://github.com/peweisberg-fadv>

[Phil Jackson] <https://github.com/philjackson>

[Rémi Vanicat] <https://github.com/vanicat>

[Yann Hodique] <https://yann.hodique.info>

[contributed code] <https://stats.magit.vc/magit/authors.html>
