tinytldr

Minimalist tldr command line client, written in plain C99.

PREVIEW

• Never gets in the way.
• Displays a page in under 5 ms.

srcery - terminal colorscheme on the screenshot.

INSTALL

Satisfy the dependencies first, and then:

git clone https://git.sr.ht/~kovmir/tinytldr
cd tinytldr
# Optional: Adjust ./config.h to your linking.
make
sudo make install

USAGE

tldr -u # Fetch or update pages.
tldr cd # View 'cd' page.
tldr windows/scoop # One could specify a platform.
tldr common/git-apply

This implementation does not and will not support tldr-pages client specification, as it makes clients identical for no reason and goes against the minimalist approach of this project.

DEPENDENCIES

• GNU Make
• pkg-config
• GCC or Clang
• libarchive
• libcurl

SUPPORTED OPERATING SYSTEMS

• Linux
• BSD
• M$ Windows

FAQ

Q: Can I use it to display my personal pages?

A: Yes, you can.

TLDR_PAGES="$HOME/.local/share/tinytldr/pages"
mkdir "$TLDR_PAGES/mypages"
echo '# My custom page' > "$TLDR_PAGES/mypages/testpage.md"
tldr -i
tldr testpage

CREDITS

Thanks @bilditup1 for Windows support.

CONTRIBUTING

When submitting PRs, please maintain the coding style used for the project.