README: add install instructions

master
Michele Guerini Rocco 2020-09-23 18:56:00 +02:00
parent b16ef6790d
commit 78a99460ac
Signed by: rnhmjoj
GPG Key ID: BFBAF4C975F76450
1 changed files with 25 additions and 1 deletions

View File

@ -1,6 +1,30 @@
# Bisc
### A small tool that clears qutebrowser cookies
## Installation
bisc is Haskell program available on [Hackage][hackage] and can
be installed with one of the Haskell package managers. For
example, with [cabal-install][cabal] you would do
```
cabal install bisc
```
and similarly for [stack][stack].
Alternatively, if you are using Nix or NixOS, bisc is available
under the attribute `haskellPackages.bisc`. It should also be in
the Nix binary cache so you don't have to build from source.
Finally, a statically compiled binaries can be found in the
[releases](/git/rnhmjoj/bisc/releases).
[hackage]: http://hackage.haskell.org/package/bisc
[cabal]: https://github.com/haskell/cabal/blob/master/cabal-install/README.md
[stack]: https://docs.haskellstack.org/en/stable/README/
## Configuration
The bisc configuration file is `$XDG_CONFIG_HOME/bisc/bisc.conf`.
@ -26,7 +50,7 @@ Run `bisc` to delete all non-whitelisted data from qutebrowser.
## License
Copyright (C) 2019 Michele Guerini Rocco
Copyright (C) 2020 Michele Guerini Rocco
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by