Commit Graph

306 Commits

Author SHA1 Message Date
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
sharkdp
bf78b74db4 Minor README improvements 2020-10-14 08:24:20 +02:00
Terence
f80fba4d24
Integrate README.md with new assets.md (#1293) 2020-10-14 08:18:11 +02:00
sharkdp
de6680bdf2 Move syntax mapping section 2020-10-11 21:11:26 +02:00
David Peter
0a28da0cd0
Small improvement to the syntax mapping section 2020-10-11 21:07:56 +02:00
henil
bce304a800 made requested changes 2020-10-11 20:54:37 +02:00
henil
206d3e7b91 fix a typo 2020-10-11 20:54:37 +02:00
henil
4be32cf746 add new section for sytax of file in README.md 2020-10-11 20:54:37 +02:00
henil
4ec6075f81 minor update to specify pattern matching on --map-syntax supports glob matching 2020-10-11 20:54:37 +02:00
henil
aa00e0a6b0 fix section 2020-10-11 20:54:37 +02:00
henil
bb7fae72c9 add a new syntax section 2020-10-11 20:54:37 +02:00
henil
7bd19640a2 add new --map-syntax example 2020-10-11 20:54:37 +02:00
David Peter
3609700b5e
Add keith-hall as a maintainer! 2020-10-05 23:11:10 +02:00
Quang Le
0ac211140a document: Update README.md using cargo install --path 2020-10-04 13:29:52 +02:00
Thomas Gotwig
14092fbadb Apply requested changes regarding Homebrew 🍺 2020-10-04 11:14:32 +02:00
Thomas Gotwig
35ad76771d Mention Homebrew on Linux 🍺🐧 2020-10-04 11:14:32 +02:00
sharkdp
2f9ecf9044 Bump version to 0.16.0 2020-10-02 20:45:29 +02:00
sharkdp
4bd1b157ae Add comment about Mandoc, closes #1145 2020-10-02 20:45:29 +02:00
sharkdp
2beec1f3ea Add comment about missing man page / completions, see #1198 2020-10-01 21:16:10 +02:00
apotheon
99c04a8740 update README to clarify disjunctive licensing 2020-08-29 10:59:08 +02:00
David Peter
b0f8841217 Fix typo 2020-08-03 17:48:16 +02:00
Mehrad Mahmoudian
febe335831 Clarified which pager is used in docs 2020-08-03 17:48:16 +02:00
Mitchell Kember
f9d5e81f0e Add new theme: base16-256
Bat already has a base16 theme. The new base16-256 theme is for users
of base16-shell, who configure their terminal with a 256-color variant
of a base16 theme. These variants put some of the base16 colors in
elsewhere in the 256-color table to avoid clobbering bright color slots
(ansi codes 8 to 15) with colors that don't respect the ordinary meaning
of that slot (e.g. bright green in ordinary base16 is not green).

For more details, see https://github.com/chriskempson/base16-shell
2020-08-03 11:39:49 +02:00
David Peter
db157567fd
Use GitHub Actions badge 2020-08-02 21:53:59 +02:00
Attila Gonda
3956e96e74 Add clarification about how the indentation works 2020-07-09 08:13:52 +02:00
AJ ONeal
62014c1094 Make Windows 10 dependencies more clear 2020-07-05 12:20:59 +02:00
David Peter
05027b7c74
Remove outdated Docker installation method 2020-07-02 08:36:01 +02:00
David Peter
c3ec92a13f
Remove outdated Ansible installation method 2020-06-07 22:55:32 +02:00
David Peter
c3230a68bb
README layout 2020-06-05 22:42:32 +02:00
Sergey Duck
d0da5af810 fix link to translation 2020-06-03 22:21:13 +02:00
Sergey Duck
2d7796284b First part of russian translation 2020-06-03 22:21:13 +02:00
Alexander Jackson
6e3e7dafca Clarify more wording when reading from stdin
Update the word 'initial' to be 'first', as this is more ubiquitous and
potentially easier for non-native speakers.

Clarify that it is the highlighting that may not work, and the input
will still be displayed regardless.
2020-06-03 09:01:23 +02:00
Alexander Jackson
fca83bf79a Clarify stdin syntax highlighting in the README
Clarify the requirements for automatic syntax highlighting when reading
input from stdin. Fixes #1028.
2020-06-03 09:01:23 +02:00
vwvw
b8ffb8d463 fix typo in readme 2020-06-02 21:53:50 +02:00
sharkdp
9e65ecd03e Updates for v0.15.4 2020-05-27 10:14:32 +02:00
sharkdp
302707f3ce Bump version to 0.15.3 2020-05-26 08:11:41 +02:00
sharkdp
28af18ba27 Bump version to 0.15.2 2020-05-25 17:27:27 +02:00
sharkdp
d6abad908a Update README and CHANGELOG, see #650 2020-05-24 10:01:53 +02:00
sharkdp
6ceba56288 Add 'mkdir -p …' to Ubuntu instructions, see #982 2020-05-12 18:35:35 +02:00
David Peter
4be66f8b88
Update README.md 2020-05-12 17:42:52 +02:00
David Peter
54a85d98f1
Add instructions for ~/.local/bin/bat symlink 2020-05-12 17:41:15 +02:00
Ethan P
1a6e8d297f Update README to mention batcat for Debian/Ubuntu 2020-05-12 11:08:21 +02:00
sharkdp
2596bfe7a7 Bump version to v0.15.1 2020-05-11 20:30:45 +02:00
sharkdp
2b1d53fb27 Add '--locked' flag to all 'cargo install' commands 2020-04-27 23:43:18 +02:00
sharkdp
17d98724a5 Bump version to v0.15.0 2020-04-25 13:09:24 +02:00
sharkdp
abeac8b12e Bump min. required Rust version to 1.40 2020-04-24 09:57:57 +02:00
sharkdp
9e622a1a5f Update version in README 2020-04-23 00:56:27 +02:00
Brice Dutheil
37831cdcb3 Fix README phrasing about dark mode 2020-04-21 22:37:24 +02:00
Michael Diamond
4cc2989fe9 Clarify the Ubuntu/Debian install instructions
A cursory reading of the existing text would lead a reader to think `bat`should be available on Debian, which isn't really true. Most users are not running Sid, so `bat` isn't yet available to them.
2020-04-17 14:10:08 +02:00
Josh Mickley
7c50fe5fec Document the --generate-config-file option 2020-03-26 09:14:40 +01:00
Marco Ieni
4aef8c180a README: fix manpage syntax link 2020-03-25 20:07:50 +01:00
Igor Raits
136a745c5d chore: Update liquid to 0.20
Signed-off-by: Igor Raits <i.gnatenko.brain@gmail.com>
2020-03-22 21:37:14 +01:00
sharkdp
c13935f3c0 Bump version to 0.13, see #845 2020-03-22 11:23:16 +01:00