Commit Diff
Diff:
a7d562e2639cef770b9482636a1395c7cac8aec0
050e6b17b879c1eb994fd3cb1178e5943436797a
Commit:
050e6b17b879c1eb994fd3cb1178e5943436797a
Tree:
d35a3f50e37fc4407e7633deb48b23c2c187f4c7
Author:
Omar Polo <op@omarpolo.com>
Date:
Wed Nov 2 20:20:13 2022 UTC
Message:
mention libgrapheme in the README.md

while here collect the links at the end.
commit - a7d562e2639cef770b9482636a1395c7cac8aec0
commit + 050e6b17b879c1eb994fd3cb1178e5943436797a
blob - 5303b49b57a70c4cc1b042c91cc8562378406e1d
blob + 2b407d8e2a10d529a4ba6ce557ebf3cafd32bffc
--- README.md
+++ README.md
@@ -76,8 +76,10 @@ libretls), libevent (either v1 or v2) and pkg-config.
## Building
Telescope depends on ncursesw, libtls (from either LibreSSL or
-libretls), libevent (either v1 or v2) and pkg-config. When building
-from a git checkout, yacc (or bison) is also needed.
+libretls), libevent (either v1 or v2) and pkg-config.
+[libgrapheme][libgrapheme] is an optional dependency: there's a
+bundled copy but it's reccomended to install it if available. When
+building from a git checkout, yacc (or bison) is also needed.
To build from a release tarball just execute:
@@ -88,9 +90,8 @@ provided by your distribution instead of using the bun
The configure script has optional support for building with libraries
provided by your distribution instead of using the bundled versions:
- - `--with-libbsd`: link with [libbsd](https://libbsd.freedesktop.org)
- - `--with-libimsg`: link with the
- [imsg-compat](https://github.com/bsd-ac/imsg-compat) library
+ - `--with-libbsd`: link with [libbsd][libbsd]
+ - `--with-libimsg`: link with the [imsg-compat][imsg-compat] library
If you want to build from the git checkout, something that's
discouraged for users that don't intend to hack on telescope
@@ -107,7 +108,11 @@ everything is working as intended.
comprehensive testing on various platforms is done to ensure
everything is working as intended.
+[libbsd]: https://libbsd.freedesktop.org
+[imsg-compat]: https://github.com/bsd-ac/imsg-compat
+[libgrapheme]: https://libs.suckless.org/libgrapheme/
+
## Contributing
Any form of contribution is appreciated, not only patches or bug
Omar Polo