Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kovmir/tinytldr
Minimalist tldr command line client written in C
https://github.com/kovmir/tinytldr
cheatshets manpages tldr tldr-client
Last synced: 3 months ago
JSON representation
Minimalist tldr command line client written in C
- Host: GitHub
- URL: https://github.com/kovmir/tinytldr
- Owner: kovmir
- License: mit
- Created: 2020-04-06T12:11:18.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-02-29T16:52:07.000Z (11 months ago)
- Last Synced: 2024-07-30T20:54:23.932Z (6 months ago)
- Topics: cheatshets, manpages, tldr, tldr-client
- Language: C
- Homepage:
- Size: 80.1 KB
- Stars: 18
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# tinytldr
Minimalist [tldr][1] command line client, written in plain C99.
# PREVIEW
*[srcery][2] - terminal colorscheme on the screenshot.*
# INSTALL
## Package
* [Slackware][3]
## Compile from source
Satisfy the [dependencies](#dependencies) first, and then:
```bash
git clone https://github.com/kovmir/tinytldr
cd tinytldr
# Optional: Adjust ./config.h to your linking.
make
sudo make install
```
# USAGE
```bash
tldr -u # Fetch or update pages.
tldr cd # View 'cd' page.
tldr windows/scoop # Or one could specify a platform.
```
# DEPENDENCIES
* ^[GNU Make][4]
* ^[pkg-config][5]
* ^[GCC][6] or [Clang][7]
* [libarchive][8]
* [libcurl][9]
*^: compilation time only dependencies.*
# SUPPORTED OPERATING SYSTEMS
* Linux
* BSD
* M$ Windows
# FAQ
**Q: Can I use it to display my personal pages?**
A: You can, see [this issue][10].
# CREDITS
Thanks [@bilditup1](https://github.com/bilditup1) for Windows support.
# CONTRIBUTING
When submitting PRs, please maintain the [coding style][11] used for the
project.
[1]: https://tldr.sh/
[2]: https://srcery.sh/
[3]: https://slackbuilds.org/repository/15.0/misc/tinytldr/?search=tinytldr
[4]: https://www.gnu.org/software/make/
[5]: https://gitlab.freedesktop.org/pkg-config/pkg-config
[6]: https://gcc.gnu.org/
[7]: https://clang.llvm.org/
[8]: https://www.libarchive.org/
[9]: https://curl.se/libcurl/
[10]: https://github.com/kovmir/tinytldr/issues/6#issuecomment-1884332215
[11]: https://suckless.org/coding_style/