# remembering

Add memory to [`dmenu`][dmenu], [`fzf`][fzf] and similar tools.

It can wrap such tools to accumulate preferences over time, and
re-arrange the input according to common picks.


## Usage

Replace:
```shell
$ ls | fzf
```

with:
```shell
$ ls | remembering -p fzf-sample -c fzf
```

and see your previous choices from `fzf` start to appear at the beginning of the list.

Similar to [`yeganesh`][yeganesh], but with no build-time or run-time dependencies, and not coupled with `dmenu`.

[dmenu]: https://tools.suckless.org/dmenu/
[fzf]: https://github.com/junegunn/fzf
[yeganesh]: http://dmwit.com/yeganesh/


## Installation

Get the latest tarball and install it:

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

The requirements are a C99 compiler on a POSIX.1-2008
environment (`_POSIX_C_SOURCE 200809L`).


## Documentation

The documentation is available via installed manpages or online: [`remembering.1`] and [`remembering.5`].

[`remembering.1.html`]: https://euandreh.xyz/remembering/remembering.1.html
[`remembering.5.html`]: https://euandreh.xyz/remembering/remembering.5.html


## Contributing

Extra tools used for development are:
- [fallible] and [Valgrind] for memory testing;
- [ShellCheck] for validating scripts;
- [pandoc], troff and Perl for generating the documentation HTML and website.

[fallible]: https://fallible.euandreh.xyz
[Valgrind]: https://valgrind.org
[ShellCheck]: https://www.shellcheck.net/
[pandoc]: https://pandoc.org/

For running the extra development-only checks, run:

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

and for generating the documentation HTML and website, run:

```shell
$ make public
```

Send contributions to the [mailing list] via [`git send-email`](https://git-send-email.io/).


## Links

- [home page](https://euandreh.xyz/remembering/)
- [source code](https://git.euandreh.xyz/remembering/)
- [bug tracking](https://euandreh.xyz/remembering/TODOs.html)
- [mailing list]
- [CI logs](https://euandreh.xyz/remembering/ci.html)
- [CHANGELOG](https://euandreh.xyz/remembering/CHANGELOG.html)

[mailing list]: https://lists.sr.ht/~euandreh/public-inbox?search=%5Bremembering%5D


## Releases

- version [v0.2.1](https://git.euandreh.xyz/remembering/snapshot/remembering-v0.2.1.tar.gz) ([sig](https://git.euandreh.xyz/remembering/snapshot/remembering-v0.2.1.tar.gz.asc)), released in 2021-02-23
- version [v0.2.0](https://git.euandreh.xyz/remembering/snapshot/remembering-v0.2.0.tar.gz) ([sig](https://git.euandreh.xyz/remembering/snapshot/remembering-v0.2.0.tar.gz.asc)), released in 2021-02-21
- version [v0.1.2](https://git.euandreh.xyz/remembering/snapshot/remembering-v0.1.2.tar.gz) ([sig](https://git.euandreh.xyz/remembering/snapshot/remembering-v0.1.2.tar.gz.asc)), released in 2021-01-26
- version [v0.1.1](https://git.euandreh.xyz/remembering/snapshot/remembering-v0.1.1.tar.gz) ([sig](https://git.euandreh.xyz/remembering/snapshot/remembering-v0.1.1.tar.gz.asc)), released in 2021-01-26
- version [v0.1.0](https://git.euandreh.xyz/remembering/snapshot/remembering-v0.1.0.tar.gz) ([sig](https://git.euandreh.xyz/remembering/snapshot/remembering-v0.1.0.tar.gz.asc)), released in 2021-01-26


## 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://git.euandreh.xyz/remembering/tree/COPYING