Skip to content

Commit

Permalink
chore: bump actions/checkout to v4, update README, add `.gitattribute…
Browse files Browse the repository at this point in the history
…s` (#45)

Signed-off-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>
  • Loading branch information
kbdharun authored Oct 22, 2023
1 parent 437c597 commit c8fa813
Show file tree
Hide file tree
Showing 4 changed files with 26 additions and 11 deletions.
1 change: 1 addition & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
* text=auto eol=lf
4 changes: 2 additions & 2 deletions .github/workflows/build-release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ jobs:

steps:
- name: Checkout the repository
uses: actions/checkout@v3
uses: actions/checkout@v4

- name: Create the release
env:
Expand Down Expand Up @@ -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') }}
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down
28 changes: 21 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,48 +16,62 @@ A [tldr](https://tldr.sh) client written in Rust.

</div>


## 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.
Expand Down

0 comments on commit c8fa813

Please sign in to comment.