Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/stacked-git/stgit

Stacked Git
https://github.com/stacked-git/stgit

git

Last synced: 1 day ago
JSON representation

Stacked Git

Awesome Lists containing this project

README 

        
# Stacked Git



Stacked Git, **StGit** for short, is an application for managing Git

commits as a stack of patches.



With a *patch stack* workflow, multiple patches can be developed

concurrently and efficiently, with each patch focused on a single

concern, resulting in both a clean Git commit history and improved

productivity.



For a complete introduction to StGit, see the [Stacked Git

homepage](https://stacked-git.github.io).



## Getting started



To get a feel for how StGit works, see this brief [example of StGit in

action][example]. Or check out the [in-depth tutorial][tutorial].



[example]: https://stacked-git.github.io/guides/usage-example

[tutorial]: https://stacked-git.github.io/guides/tutorial



StGit also has a complete set of [man pages][man] describing the

[`stg`][stg] command line tool and each of its subcommands.



[man]: https://stacked-git.github.io/man

[stg]: https://stacked-git.github.io/man/stg



## Installation



See [`CHANGELOG.md`](CHANGELOG.md) to see what has changed in the latest

StGit release.



### Dependencies



StGit is implemented in Rust using a number of third-party, open source

crates. StGit statically links with its pure-Rust dependencies, but

dynamically links to libc and other non-Rust libraries when they are

available at build-time. Dynamic link dependencies include these

libraries along with their transient link dependencies:



- libcurl (optional)



StGit works within the context of a Git repository and performs many

operations by running subordinate `git` commands.

[Git](https://git-scm.com) 2.2.0 or newer is required.



### Package Repositories



Recent versions of StGit are available in several package repositories

such as [HomeBrew][pkg-homebrew] and [MacPorts][pkg-macports] for MacOS

and for the [Arch][pkg-arch] and [Gentoo][pkg-gentoo] Linux

distributions. StGit is also available via [crates.io][pkg-crate],

[guix][pkg-guix], and [nix][pkg-nix].



More details about StGit packages availability for various operating

systems can be [found on repology][repology].



[pkg-homebrew]: https://formulae.brew.sh/formula/stgit

[pkg-macports]: https://ports.macports.org/port/stgit/

[pkg-arch]: https://aur.archlinux.org/packages/stgit

[pkg-gentoo]: https://packages.gentoo.org/packages/dev-vcs/stgit

[pkg-crate]: https://crates.io/crates/stgit

[pkg-guix]: https://packages.guix.gnu.org/packages/stgit/

[pkg-nix]: https://search.nixos.org/packages?type=packages&query=stgit

[repology]: https://repology.org/project/stgit/versions



### Prebuilt Packages



Prebuilt deb, rpm, and msi packages are provided by the StGit project.

Packages for the latest release may be found [here][latest].



Note that the Linux deb and rpm packages are unofficial. The upstream

Debian and RedHat/Fedora projects currently only publish outdated

versions of StGit (see [repology][repology]). These unofficial packages

are meant to be a stop-gap until official StGit packages are provided by

downstream distributions.



The Linux deb and rpm packages are statically linked use [`musl`][musl]

libc to maximize compatibility. They should hopefully work on a wide

range of deb and rpm based distributions.



[musl]: https://musl.libc.org/



### Source Installation



StGit may also be installed from source. Download the [latest

release][latest] or clone from the [StGit repository on GitHub][repo].



[latest]: https://github.com/stacked-git/stgit/releases/latest

[repo]: https://github.com/stacked-git/stgit



To install the `stg` executable from source, choose a `prefix` and run:



```shellsession

$ make prefix=$HOME/.local install

```



For more information about installation, see [`INSTALL.md`](INSTALL.md).



## Contributing



See [`CONTRIBUTING.md`](CONTRIBUTING.md) for a full guide to contributing

to StGit.



## Maintainers



StGit is maintained by Catalin Marinas and Peter Grayson.



For a complete list of StGit's authors, see [`AUTHORS.md`](AUTHORS.md).