diff options
| author | Yuqian Yang <crupest@crupest.life> | 2025-01-26 23:12:59 +0800 |
|---|---|---|
| committer | Samuel Thibault <samuel.thibault@ens-lyon.org> | 2025-01-26 16:50:49 +0100 |
| commit | a2ae55c943f54cbd5e70508a53eeff2ec9cf1ed5 (patch) | |
| tree | 6326c51b92f160467701e820d50c9895f7321b8f | |
| parent | 3fb95a2d969e869e9ae4ea85595fb91c08272327 (diff) | |
| download | web-a2ae55c943f54cbd5e70508a53eeff2ec9cf1ed5.tar.gz web-a2ae55c943f54cbd5e70508a53eeff2ec9cf1ed5.tar.bz2 web-a2ae55c943f54cbd5e70508a53eeff2ec9cf1ed5.zip | |
Add doc of topgit installation to make it easier.
One notable problem is that topgit is default to install to prefix `~`
rather than `~/.local`, which might surprise some people.
Message-ID: <dd9fa4d97a742e6fbed9bd607930132a@crupest.life>
| -rw-r--r-- | topgit.mdwn | 29 |
1 files changed, 29 insertions, 0 deletions
diff --git a/topgit.mdwn b/topgit.mdwn index b27aa09c..14d3c53e 100644 --- a/topgit.mdwn +++ b/topgit.mdwn @@ -27,6 +27,35 @@ We're using this for some packages, where we're maintaining long-lived development branches, for example [[source_repositories/glibc]]. The latter one has usage examples, too. +# Installing + +It's fairly easy to install topgit. First, clone the git repo of topgit. + + $ git clone https://repo.or.cz/topgit.git + $ cd topgit + +Or download the tarball of source code directly and unpack it. + + $ curl -o topgit.tar.gz https://repo.or.cz/topgit.git/snapshot/f2815f4debdb07f86ee86dd4eb75280919ace55d.tar.gz + $ tar xzf topgit.tar.gz + $ cd topgit-f2815f4 + +Second, you have to build and install topgit with make. You can use +any prefix to specify the install place. But note that, if you +don't set `prefix`, it will default to `$HOME` rather than `$HOME/.local`, +which may NOT be what you want. + + $ make prefix=$HOME/.local install + +The topgit executable file is `tg`. It will be installed into `$prefix/bin`. + +Finally, add `$prefix/bin` to your `PATH` if you want to use `tg` directly in +your shell. Then test the installation by running `tg` and check the output. + + $ tg + TopGit v0.9 - A different patch queue manager + Usage: tg [...] + # Running it on GNU/Hurd |