README.md

   1 # Stacked Git
   2
   3 Stacked Git, **StGit** for short, is an application for managing Git
   4 commits as a stack of patches.
   5
   6 With a *patch stack* workflow, multiple patches can be developed
   7 concurrently and efficiently, with each patch focused on a single
   8 concern, resulting in both a clean Git commit history and improved
   9 productivity.
  10
  11 For a complete introduction to StGit, see the [Stacked Git
  12 homepage](https://stacked-git.github.io).
  13
  14 ## Getting started
  15
  16 To get a feel for how StGit works, see this brief [example of StGit in
  17 action][example]. Or check out the [in-depth tutorial][tutorial].
  18
  19 [example]: https://stacked-git.github.io/guides/usage-example
  20 [tutorial]: https://stacked-git.github.io/guides/tutorial
  21
  22 StGit also has a complete set of [man pages][man] describing the
  23 [`stg`][stg] command line tool and each of its subcommands.
  24
  25 [man]: https://stacked-git.github.io/man
  26 [stg]: https://stacked-git.github.io/man/stg
  27
  28 ## Installation
  29
  30 See [CHANGELOG.md](CHANGELOG.md) to see what has changed in the latest
  31 StGit release.
  32
  33 ### Dependencies
  34
  35 StGit is written in pure Python with no third-party Python dependencies.
  36 StGit supports Python versions >= 3.5.
  37
  38 StGit works within the context of a Git repository by running `git`
  39 commands. [Git](https://git-scm.com) 2.2.0 or newer is required.
  40
  41 ### Package Repositories
  42
  43 Recent versions of StGit are available via many package repositories
  44 such as [HomeBrew](https://formulae.brew.sh/formula/stgit) and for many
  45 Linux distributions including:
  46 [Alpine](https://pkgs.alpinelinux.org/packages?name=stgit),
  47 [Arch](https://aur.archlinux.org/packages/stgit),
  48 [Fedora](https://src.fedoraproject.org/rpms/stgit),
  49 [Nix](https://nixos.org/nixos/packages.html?attr=gitAndTools.stgit) and
  50 [Ubuntu](https://packages.ubuntu.com/source/focal/stgit).
  51
  52 More details about StGit packages availability for various operating
  53 systems can be [found on repology][repology].
  54
  55 [repology]: https://repology.org/project/stgit/versions
  56
  57 ### Source Installation
  58
  59 StGit may also be installed from source. Download the [latest
  60 release][latest] or clone from the [StGit repository on GitHub][repo].
  61
  62 [latest]: https://github.com/stacked-git/stgit/releases/latest
  63 [repo]: https://github.com/stacked-git/stgit
  64
  65 To install from source, choose a `prefix` and run:
  66
  67 ``` shellsession
  68 $ make prefix=/usr/local install install-doc
  69 ```
  70
  71 For more information about installation, see [INSTALL](INSTALL).
  72
  73 ## Contributing
  74
  75 See [CONTRIBUTING.md](CONTRIBUTING.md) for a full guide to contributing
  76 to StGit.
  77
  78 ## Maintainers
  79
  80 StGit is maintained by Catalin Marinas and Peter Grayson.
  81
  82 For a complete list of StGit's authors, see [AUTHORS.md](AUTHORS.md).