extern/bat
1
0
Fork 0
mirror of https://github.com/sharkdp/bat.git synced 2025-05-31 06:56:56 +02:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #3298 from ZaneErebos/patch-2

Browse Source 
Clarify situation in which man page and shell completions will be accessible when building from source
This commit is contained in:
Keith Hall 2025-05-19 04:42:28 +03:00 committed by GitHub
commit c32fa662d5
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 13 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -468,14 +468,25 @@ binaries are also available: look for archives with `musl` in the file name.
If you want to build `bat` from source, you need Rust 1.74.0 or If you want to build `bat` from source, you need Rust 1.74.0 or
higher. You can then use `cargo` to build everything: higher. You can then use `cargo` to build everything:
#### From local source
```bash
cargo install --path . --locked
```
> [!NOTE]
> The `--path .` above specifies the directory of the source code and NOT where `bat` will be installed.
> For more information see the docs for [`cargo install`](https://doc.rust-lang.org/cargo/commands/cargo-install.html).
#### From `crates.io`
```bash ```bash
cargo install --locked bat cargo install --locked bat
``` ```
Note that additional files like the man page or shell completion Note that additional files like the man page or shell completion
files can not be installed in this way. They will be generated by `cargo` and should be available in the cargo target folder (under `build`). files can not be installed automatically in both these ways.
If installing from a local source, they will be generated by `cargo`
and should be available in the cargo target folder under `build`.
Shell completions are also available by running: Furthermore, shell completions are also available by running:
```bash ```bash
bat --completion <shell> bat --completion <shell>
# see --help for supported shells # see --help for supported shells