Skip to content
This repository was archived by the owner on Dec 24, 2024. It is now read-only.

Update README.md #9

Merged
merged 1 commit into from
Feb 29, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 36 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,22 @@
# tinytldr

Minimalist [tldr](https://tldr.sh/) command line client, written in plain C99.

# KILLER FEATURES

* It builds.
* And then works.
* Small.
* Cross platform, tested on Linux, Windows, and FreeBSD.
* Depends on nothing but libcurl and libarchive.
Minimalist [tldr][1] command line client, written in plain C99.

# PREVIEW

![screenshot](screenshot.png)

*[srcery](https://srcery.sh/) - terminal colorscheme on the screenshot.*
*[srcery][2] - terminal colorscheme on the screenshot.*

# INSTALL

## Package

* [Slackware](https://slackbuilds.org/repository/15.0/misc/tinytldr/?search=tinytldr)
* [Slackware][3]

## Compile from source

Satisfy [dependencies](#dependencies) first, and then:
Satisfy the [dependencies](#dependencies) first, and then:

```bash
git clone https://github.com/kovmir/tinytldr
Expand All @@ -44,17 +36,43 @@ tldr windows/scoop # Or one could specify a platform.

# DEPENDENCIES

* [libarchive](https://www.libarchive.org/)
* [libcurl](https://curl.se/libcurl/)
* ^[pkg-config](https://gitlab.freedesktop.org/pkg-config/pkg-config)
* ^[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?**

*^: compilation time dependencies.*
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](https://suckless.org/coding_style/) used for the project.
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/