~yoctocell/gralc

ec806ce196100ac4675e6115c5248d13d8bc6204 — yoctocell 1 year, 7 months ago fba5529 master
README: Update installation instructions
1 files changed, 3 insertions(+), 27 deletions(-)

M README.md
M README.md => README.md +3 -27
@@ 1,39 1,15 @@
# Gralc
[![Built with Nix](https://builtwithnix.org/badge.svg)](https://builtwithnix.org)

A preprocessor for Groff/Troff that lets you do arithmetic in Python.

# Installation
Download the `src/gralc.py` file and put it in your `$PATH`.

## Nix-build
Change directory to the root of the project and run `nix-build` to install gralc in `./result/bin/gralc`.

## Flake.nix
If you have flake enable, run `nix run 'github:yoctocell/gralc'`.

## NUR
You can install gralc from the [NUR](https://github.com/nix-community/nur). Using `nix-shell`

```sh
$ nix-shell -p nur.repos.yoctocell.pkgs.gralc
```
Change directory to the root of the project and run `nix-build` to install gralc in `./result/bin/gralc.py`.

Using `nix-env`
## Nix Flakes
If you have nix flakes enabled, you can run `nix shell git+https://git.sr.ht/~yoctocell/nixrc#gralc`.

```sh
$ nix-env -f '<nixpkgs>' -iA nur.repos.yoctocell.pkgs.gralc
```

With home-manager

```nix
{
  home.packages = [
    pkgs.nur.repos.yoctocell.pkgs.gralc
  ];
}
```

# Usage
To perform arithmetic, write your expression between `\P`` and ``` (variables aren't supported tho).