From c8fa813544ee85c62d2ddc5205fb626bd89d30bd Mon Sep 17 00:00:00 2001 From: "K.B.Dharun Krishna" Date: Sun, 22 Oct 2023 22:19:13 +0530 Subject: [PATCH] chore: bump actions/checkout to v4, update README, add `.gitattributes` (#45) Signed-off-by: K.B.Dharun Krishna --- .gitattributes | 1 + .github/workflows/build-release.yml | 4 ++-- .github/workflows/ci.yml | 4 ++-- README.md | 28 +++++++++++++++++++++------- 4 files changed, 26 insertions(+), 11 deletions(-) create mode 100644 .gitattributes diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..6313b56 --- /dev/null +++ b/.gitattributes @@ -0,0 +1 @@ +* text=auto eol=lf diff --git a/.github/workflows/build-release.yml b/.github/workflows/build-release.yml index 4021750..76011e6 100644 --- a/.github/workflows/build-release.yml +++ b/.github/workflows/build-release.yml @@ -21,7 +21,7 @@ jobs: steps: - name: Checkout the repository - uses: actions/checkout@v3 + uses: actions/checkout@v4 - name: Create the release env: @@ -52,7 +52,7 @@ jobs: steps: - name: Checkout the repository - uses: actions/checkout@v3 + uses: actions/checkout@v4 - name: Install musl libc if: ${{ contains(matrix.target, 'musl') }} diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index ab0010a..311b941 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -14,7 +14,7 @@ jobs: steps: - name: Checkout the repository - uses: actions/checkout@v3 + uses: actions/checkout@v4 - name: Update Rust run: rustup update stable - name: Run rustfmt @@ -26,7 +26,7 @@ jobs: steps: - name: Checkout the repository - uses: actions/checkout@v3 + uses: actions/checkout@v4 - name: Update Rust run: rustup update stable - name: Run clippy diff --git a/README.md b/README.md index 1ef7d83..405fcc9 100644 --- a/README.md +++ b/README.md @@ -16,48 +16,62 @@ A [tldr](https://tldr.sh) client written in Rust. - ## Installation + [![Packaging status](https://repology.org/badge/vertical-allrepos/tlrc.svg)](https://repology.org/project/tlrc/versions) ### Arch Linux + Install [tlrc](https://aur.archlinux.org/packages/tlrc) (from source) or [tlrc-bin](https://aur.archlinux.org/packages/tlrc-bin) (prebuilt) from the AUR. ### NetBSD + Install [tlrc](https://ftp.netbsd.org/pub/NetBSD/NetBSD-current/pkgsrc/net/tlrc/index.html) with `pkgin`. -``` + +```shell pkgin install tlrc ``` ### From crates.io + To build tlrc from a source tarball, run: -``` + +```shell cargo install tlrc ``` + **NOTE:** shell completion files and the man page will not be installed that way. ### From GitHub Releases -You can find prebuilt binaries [here][latest-release]. +You can find prebuilt binaries [here][latest-release]. ## Usage + See `man tldr` or the [online manpage](https://tldr.sh/tlrc). For a brief description, you can also run: -``` + +```shell tldr --help ``` ## Configuration + Tlrc can be customized with a [TOML](https://toml.io) configuration file. To get the default path for your system, run: -``` + +```shell tldr --config-path ``` + To generate a default config file, run: -```bash + +```shell tldr --gen-config > $(tldr --config-path) ``` + or copy the below example. ### Configuration options + ```toml [cache] # Override the cache directory.