# git-permalink

Git extension to generate web permalinks of files in a repository.

It knows about many of the existing code forges, but allows for URL
template overrides to be used on custom domains or deployments via git
config.


## Usage


## Installation

Get the latest tarball and install it:

```shell
wget https://git.euandreh.xyz/git-permalink/snapshot/git-permalink-main.tar.gz
pax -rzf git-permalink-main.tar.gz # or similarly: tar xf git-permalink-main.tar.gz
cd git-permalink-main/
make
[sudo] make install
```

There are no dependencies or requirements, only standard tools such as
`sed`, `mkdir`, etc.


## Documentation

The documentation is available via installed manpages or online: [`git-permalink.1`].

[`git-permalink.1.html`]: https://git.euandreh.xyz/git-permalink/git-permalink.1.html


## Contributing

Extratools used for development are:
- [ShellCheck] for validating scripts;
- [pandoc], troff and Perl for generating the documentation HTML and website.

For running the extra development-only checks, run:

```shell
$ make dev-check
```

and for generating the documentation HTML and website, run:

```shell
$ make public
```


## Links

- [home page](https://euandreh.xyz/git-permalink/)
- [source code](https://git.euandreh.xyz/git-permalink/)
- [bug tracking](https://euandreh.xyz/git-permalink/TODOs.html)
- [mailing list](https://lists.sr.ht/~euandreh/public-inbox?search=%5Bgit-permalink%5D)
- [CI logs](https://euandreh.xyz/git-permalink/ci.html)
- [CHANGELOG](https://euandreh.xyz/git-permalink/CHANGELOG.html)


## License

The code is licensed under [GNU Affero General Public License v3.0 or later][AGPL-3.0-or-later] (AGPL-3.0-or-later).

[AGPL-3.0-or-later]: https://www.gnu.org/licenses/agpl-3.0.en.html