docs: clarify bat reads files to stdout like cat(1)#3755
Open
leno23 wants to merge 2 commits into
Open
Conversation
leno23
added a commit
to leno23/bat
that referenced
this pull request
May 26, 2026
leno23
force-pushed
the
docs/clarify-project-description-2113
branch
from
630d113 to
d50b27d
Compare
The tagline now states that bat reads files and writes to stdout before calling it a cat clone, which matches common confusion in sharkdp#2113. Fixes sharkdp#2113
leno23
force-pushed
the
docs/clarify-project-description-2113
branch
from
d50b27d to
12cf523
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Clarifies the README tagline so newcomers understand
batis a command-line tool that reads files and prints to stdout (like Unixcat(1)), not a pet or unrelated project.Fixes #2113
Test plan