~evhan/chicken-sourcehut

5c0dccf255cf8f56be4a62152774d815295673cf — Evan Hanson 5 months ago c49de23 master
README clarifications and installation instructions for NixOS
1 files changed, 19 insertions(+), 6 deletions(-)

M README.md
M README.md => README.md +19 -6
@@ 1,6 1,7 @@
# chicken-sourcehut

Command line interface and CHICKEN client library for [sr.ht](https://sr.ht/).
Command line interface and [CHICKEN Scheme](https://call-cc.org/) client
library for [sourcehut](https://sourcehut.org/).

## Resources



@@ 11,31 12,43 @@ Command line interface and CHICKEN client library for [sr.ht](https://sr.ht/).

## Installation

### Extension Library
### CHICKEN Scheme Extension Library

Use your distribution's package manager to install CHICKEN 5.2 or newer,
then run:

``` shell
``` bash
chicken-install -s sourcehut
```

This will install the CHICKEN extension libraries, as well as the CLI program
under `$CHICKEN_INSTALL_PREFIX/bin/sourcehut`.
This will install the CHICKEN Scheme extension libraries, as well as the CLI
program, under `$CHICKEN_INSTALL_PREFIX/bin/sourcehut`.

On some platforms you may be required to install the OpenSSL development
libraries first.

### Command Line Interface

#### Prebuilt Binaries

If you just want to use the CLI program without installing CHICKEN first, you
can download prebuilt binaries for some common platforms [here][binaries].

[binaries]: https://foldling.org/sourcehut/

#### Nix

To build and install the package using [Nix][], you can run:

``` bash
nix-env -i -f https://git.sr.ht/~evhan/chicken-sourcehut/archive/master.tar.gz
```

[Nix]: https://nixos.org/

## Examples

### Using the Extension Library
### Using the CHICKEN Scheme Extension Library

Create a new job on [builds.sr.ht](https://builds.sr.ht/) and fetch
information about it: