Commit Graph

258 Commits

Author SHA1 Message Date
D3ara1n
a5234105e5
Add a README-zh.md as the Chinese version of README.md (#1970)
Add README-zh.md to replace the outdated one. Also fix url ref.
2021-12-05 20:18:38 +01:00
Isabella Basso
59d4cfb75c
README.md: Add 'Garbled output' to 'Troubleshooting' (#1937)
As per #234, #403, #1572, #1823 and #1897, this commit clarifies that
`bat` cannot properly handle escape sequences.

Signed-off-by: Isabella Basso <isabbasso@riseup.net>
2021-11-19 07:09:19 +01:00
Michael Currin
5d92a7c591 docs: fix up README 2021-11-02 21:34:00 +01:00
Ashutosh Sajan
d5e61d2316
update ubuntu installation command (#1911) 2021-10-23 13:00:43 +02:00
i-ky
aed4ea144f
Sync README header across translations (#1905)
* Fix links in Russian translation.
* Simplify links in Korean translation.
* Fix build status badge in Japanese and Russian translations.
* Add link from Japanese to Russian translation.
* Add line break between "topics" row and "translations" row.
* Remove "translations" from translations row in Japanese and Russian.
* Add consistent spacing between translation links.
* Add backreferences to English README.
* Remove self references.
* Split translations row across multiple lines for easier maintenance.

Co-authored-by: David Peter <sharkdp@users.noreply.github.com>
2021-10-17 21:15:23 +02:00
Raf Czlonka
eea061c1d9 Add install instructions on OpenBSD 2021-10-17 21:11:07 +02:00
invakid404
b622a4d890 chore: add funtoo linux instructions 2021-10-03 09:15:36 +02:00
Roneo.Org
b551d28a2f List available Ubuntu packages more precisely.
Ref: https://github.com/sharkdp/bat/pull/1865#issuecomment-931709001
2021-10-03 09:12:18 +02:00
Roneo.Org
e6caa04209 Minor rephrasing 2021-10-03 09:12:18 +02:00
Roneo.Org
adadedeab1 Update the doc for Ubuntu and Debian 2021-10-03 09:12:18 +02:00
Martin Nordholts
418fce5683 Bump MSRV to 1.46
See #1874 and #1872.
2021-10-03 07:51:37 +02:00
Kevin John Mulligan
156dec2737 Add context to .ino configuration
This allows a user to search the README or the entire repository for "Arduino" to find the necessary configuration.
2021-09-07 20:21:12 +02:00
Martin Nordholts
b146958ecb Bump version to v0.18.3 2021-08-22 17:47:12 +02:00
bl-ue
3b263f0917 Fix typo in README
(cherry picked from commit fc0794a83d)
2021-08-21 20:02:23 +02:00
David Peter
589df6792f Add note on vulnerability reporting, closes #1473 2021-07-13 11:00:36 +02:00
David Peter
a4b674902f Bump version to v0.18.2 2021-07-12 23:17:48 +02:00
Rémi Ait-Younes
d3aa17ae77 Update README.md 2021-06-27 21:08:59 +02:00
Rémi Ait-Younes
4187eed12b Update README.md 2021-06-27 21:08:59 +02:00
Martin Nordholts
2a71852070 README.md: List compatibility as another advantage to 3-bit themes
See discussion in #1681.
2021-06-10 13:54:24 +02:00
Martin Nordholts
c8dd32802d README.md: Mention that PAGER is ignored if set to more or most
Fixes #1666
2021-06-08 07:13:46 +02:00
David Peter
73dab51ad1 Bump version, update dependencies 2021-05-12 22:55:25 +02:00
Sean Wei
db57454f3f Update copyright year 2021-03-10 19:37:21 +01:00
David Peter
52f84b063c Update dependencies, MSRV: 1.45 2021-03-07 15:33:37 +01:00
David Peter
cfc505e1e5 Bump version to v0.18.0 2021-02-28 18:57:11 +01:00
David Peter
c569774e1a
Add section about integration with fzf
see #448
2021-02-27 11:47:04 +01:00
David Peter
70cf8a4ec5 Wording 2021-02-15 22:39:48 +01:00
Martin Nordholts
37d0d8984c README.md: Warn about buggy snap packages
As discussed in #1519, the batcat snap package is too problematic for
official endorsement, so withdraw recommendation from README.me (and
remove section from CHANGELOG.md since a release with it has not been
made yet).
2021-02-15 22:39:48 +01:00
sharkdp
b0e5828d3f Add comment regarding use of bat as a library, closes #953 2021-01-10 22:24:32 +01:00
sharkdp
b7d499d1be Add 'batcat' comment in MANPAGER suggestion, closes #1434 2021-01-10 22:24:32 +01:00
sharkdp
0e2bef3b79 Fix minor mistakes in --map-syntax documentation 2021-01-10 22:24:32 +01:00
mark chaitin
de6cb75f4b Addressed PR feedback. Upped min version and used matches! macro 2021-01-09 15:21:26 +01:00
David Peter
c38c186d26
Add Enselic as a maintainer 2021-01-09 14:22:23 +01:00
David Peter
2eae8b578e
Fix repology badge 2021-01-01 23:07:13 +01:00
Mitchell Kember
3099f51ba7 Add ansi theme to replace ansi-light and ansi-dark
This combines ansi-light and ansi-dark into a single theme that works
with both light and dark backgrounds. Instead of specifying white/black,
the ansi theme uses the terminal's default foreground/background color
by setting alpha=01, i.e. #00000001. This is in addition to the alpha=00
encoding where red contains an ANSI color palette number.

Now, `--theme ansi-light` and `--theme ansi-dark` will print a
deprecation notice and use ansi instead (unless the user has a custom
theme named ansi-light or ansi-dark, which would take precedence).
2020-12-21 17:05:10 +01:00
sharkdp
ab4c120ea5 Highlight 'batcat' note in README, see #1420 2020-12-21 09:36:14 +01:00
purvesh-linux11
48e799e7a6 changing snap name to batcat 2020-12-02 08:46:29 +01:00
purvesh-linux11
b0fcb3065f add snap installtion command 2020-12-02 08:46:29 +01:00
Deshdeepak
2da11097f9 Update with termux installation 2020-11-29 16:37:42 +01:00
sharkdp
6d981498d8 Bump version to 0.17.1 2020-11-24 21:40:11 +01:00
sharkdp
8884104e82 Bump version to v0.17.0 2020-11-23 14:41:32 +01:00
Stick
ba5cbe208f
explain how to use bat as cat (no paging) 2020-11-20 11:25:45 -05:00
sharkdp
2889e017cd More detailed description for CHANGELOG section 2020-10-29 20:16:33 +01:00
Adrian Rivera
47ea99090f Style changes on CONTRIBUTORS 2020-10-29 20:16:33 +01:00
Adrian Rivera
1c1ba04c41 Adds a CONTRIBUTORS file 2020-10-29 20:16:33 +01:00
Adrian Rivera
49d7bf8c39 From a TODO in #1211. Add documentation for contributors.
This changes the README file and adds a new section `Contributors`.
This section includes instructions to remind contributors to make an
update to the changelog.
2020-10-29 20:16:33 +01:00
David Peter
dade4cc6f3
Add reference to batdiff 2020-10-29 19:37:12 +01:00
Jessé Vermeulen
85594956cf Bring back delta to me to me 2020-10-29 19:22:38 +01:00
Jesse Vermeulen
88eba56607 Add git diff example to Integration docs
Part of https://github.com/sharkdp/bat/issues/448

Thanks to https://github.com/sharkdp/bat/pull/940
2020-10-29 19:22:38 +01:00
Keith Hall
6872a4dd7f Fix small grammar mistake/typo in the readme 2020-10-15 09:10:29 +03:00
David Peter
57c1a7fd69
Formatting fix 2020-10-14 08:26:02 +02:00