Skip to content

pauloo27/tldr

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

37 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

TLDR

Unofficial TL;DR pages in Go.

not fully compatible with the specification

How to install

With Go, run:

go install github.com/pauloo27/tldr/cmd/tldr@latest

You also need to add the Go binary folder to your path, if you haven't done it yet. If you don't know where the Go binary folder is, run go env GOPATH.

Manually compiling

Clone the project:

git clone https://github.com/Pauloo27/tldr.git && cd tldr

Install it:

sudo make install

Config

Create a config at ~/.config/tldr/config.toml, example:

viewer="less"
language="en"

I recommend using bat or mdcat as the viewer

Info

The tldr pages repository will be cloned to ~/.cache/tldr-repo. Once cloned, run tldr -u to update the pages.

License

This project is licensed under the MIT license.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

About

📚️ TLDR in GO

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published