Giter Club home page Giter Club logo

tinytldr's Introduction

tinytldr

Minimalist tldr command line client, written in plain C99.

PREVIEW

screenshot

srcery - terminal colorscheme on the screenshot.

INSTALL

Package

Compile from source

Satisfy the dependencies first, and then:

git clone https://github.com/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 # Or one could specify a platform.

DEPENDENCIES

^: 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.

CREDITS

Thanks @bilditup1 for Windows support.

CONTRIBUTING

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

tinytldr's People

Contributors

bilditup1 avatar erichritz avatar kovmir avatar pixelcmtd avatar

Stargazers

avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar

Watchers

avatar avatar

Forkers

bilditup1 egelja

tinytldr's Issues

Custom pages?

This is pretty great (works great on OpenBSD too), but I'd love to add custom pages for my local scripts & commands.

What about being able to specify a second lookup directory path? tinytldr could look there first, then fallback to the one specified in PAGES_PATH... ?

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.