blob: be270f1e60333146311df47faea7aee791048508 (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
|
# remembering
Add memory to [`dmenu`][dmenu], [`fzf`][fzf] and similar tools.
## 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
Documentation available via installed manpages or online: [`remembering.1`](remembering.1.html) and [`remembering.5`](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
```
## Links
- [home page](https://euandreh.xyz/remembering/)
- [source code](https://git.euandreh.xyz/remembering/)
- [bug tracking](https://euandreh.xyz/remembering/TODOs.html)
- [mailing list](https://lists.sr.ht/~euandreh/public-inbox?search=%5Bremembering%5D)
- [CI logs](https://euandreh.xyz/remembering/ci.html)
- [CHANGELOG](https://euandreh.xyz/remembering/CHANGELOG.html)
## 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://www.gnu.org/licenses/agpl-3.0.en.html
|
