Commit Graph

268 Commits

Author SHA1 Message Date
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
sharkdp
978def2d40 Update documentation 2020-03-22 11:02:51 +01:00
cheese.cake
edf62953c4 add README-ko.md 2020-03-15 10:38:45 +01:00
sharkdp
f2b7c060a3 Add link to Choco package 2020-03-06 23:39:17 +01:00
sharkdp
08dd251b9c Update Windows install instructions 2020-03-06 23:38:07 +01:00
Anthony Cerruti
d081473261 Update README.md 2020-03-06 23:38:07 +01:00
Anthony Cerruti
3901480c59 Move VC++ to Windows section 2020-03-06 23:38:07 +01:00
Anthony Cerruti
1cad3f56ec Explain how to fix no output issue
I just ran into this so I figured it might be helpful for others.
2020-03-06 23:38:07 +01:00
sharkdp
d1bb47d741 Bump min. required Rust version to 1.36 2020-02-27 23:09:03 +01:00
Shun Sakai
90ee939671 Add information about the license to README files 2020-01-18 20:45:56 +01:00
David Peter
903af3ee09
Show master state 2020-01-12 10:59:24 +01:00
sharkdp
6684c0b07a Remove example line from config file 2019-12-23 12:45:23 +01:00
sharkdp
6568d03924 Update README 2019-12-23 12:45:23 +01:00
Ryota Kayanuma
41d547532f Fix '日本文' to '日本語' 2019-12-21 10:03:53 +01:00
David Peter
310654d49f Format "delta" like the other programs. 2019-10-30 19:47:37 +01:00
Dan Davison
3f37d292ec Point to delta in usage-with-git section of README 2019-10-30 19:47:37 +01:00
MarcoFalke
921a65f0a1
Update README.md 2019-10-28 16:26:28 -04:00
MarcoFalke
b9c07e52e8
doc: Add Ubuntu/Debian bat package to Readme
Documentation update to fix #323
2019-10-26 10:33:17 -04:00
Fahmi Akbar Wildana
d3243903c0 Add --bins flag in CI before_deploy 2019-10-20 21:43:51 +02:00
David Peter
ff0b331dd6
Add llvm/libclang install instructions. 2019-10-15 21:40:38 +02:00
sharkdp
00bfbbf884 Add section concerning file encodings, see #568 2019-10-11 21:47:40 +02:00
Rogelio Domínguez Hernández
a84c598e2c cmake and libz are not needed to install bat
Closes #649
2019-10-06 20:34:14 +02:00
Bernard Niset
6b2f78ec51 Add MacPorts instructions 2019-09-30 21:21:43 +02:00
sharkdp
4df5973fde Replace 'Printer' by 'needle' 2019-09-21 09:01:54 +02:00
sharkdp
45f3c73331 Extend 'man' integration section 2019-09-21 08:51:26 +02:00
sharkdp
4102175d98 Add '-x' flag for 'col', see #652, see #667 2019-09-21 08:44:26 +02:00
Ethan P
30ee2a464f Add eth-p/bat-extras integrations to README 2019-09-21 08:42:56 +02:00
Ethan P
7a5d1f27e7 Fix missing and inconsistent code fences in REAMDE 2019-09-21 08:42:56 +02:00
David Peter
c9c3341a38 Use bash syntax highlighting 2019-09-15 15:54:44 +02:00
Jerguš Lejko
a736889ef1 add dark mode script 2019-09-15 15:54:44 +02:00
David Peter
337ee568b1
Add list of maintainers to README 2019-09-07 08:57:07 +02:00
sharkdp
608cefb05c Bump version 2019-09-03 08:07:42 +02:00
David Peter
5815364206
Add packaging status from repology.org 2019-09-01 11:03:35 +02:00
sharkdp
c64ab29739 Update min. required rust version 2019-08-31 14:48:42 +02:00
sharkdp
ed345f2889 Fix headline 2019-08-31 14:44:11 +02:00
sharkdp
47d5130764 Bump version 2019-08-31 14:43:04 +02:00
sharkdp
4ba45e2ba2 Add first version of 'man page' syntax, closes #523 2019-08-31 14:32:37 +02:00
sharkdp
590a1e9a4b Bump minimum supported version to 1.33 2019-08-02 21:00:33 +02:00
Igor Gnatenko
e8c04672f0 Small improvements for Fedora instructions
Anything older than F29 is EOL now, so no need to mention it. Also in F29+ you can use standard `dnf install`.
2019-07-24 21:38:11 +02:00
Chloe Kudryavtsev
d86b7cf7e0 Add Alpine Linux installation instructions
Resolves #586
2019-06-11 07:40:23 +02:00
toku-sa-n
9a44fa11c0 Add install instructions for Gentoo Users. 2019-06-09 17:50:18 +02:00
sharkdp
260814c377 Bump version to 0.11 2019-05-15 22:07:35 +02:00
rasmuskriest
e7c5561df7 Update Chocolatey package name to bat 2019-04-25 17:58:15 +02:00
rasmuskriest
0aabbc03d7 Add Chocolatey package instructions 2019-04-25 17:58:15 +02:00
Daniele Esposti
50aabf331d Updated minimum version of Rust 2019-03-09 07:43:41 +01:00
Geoff Shannon
d8f28c177a Make fd link actually link to fd 2019-02-17 09:19:42 +01:00
David Peter
fbee9df719
Add "git show" section 2019-02-11 22:04:22 +01:00
David Peter
6e9ca7d6dc
Add "xclip" section 2019-02-11 22:01:03 +01:00
David Peter
a9ec5c063a
Add documentation about "tail -f" 2019-02-11 21:54:16 +01:00
David Peter
8470fd7173
Add "Integration with other tools" section 2019-02-11 21:38:18 +01:00
sharkdp
e09499b3df Move config-dir and cache-dir from 'bat cache' to 'bat' 2019-02-07 23:27:53 +01:00
sharkdp
cff01d81fa Rename 'bat cache --init' to 'bat cache --build' 2019-02-07 23:27:53 +01:00
sharkdp
357ce84c56 Bump version to 0.10 2019-02-07 23:00:40 +01:00
Gergely Gombos
724a5fac99 Fix Fedora instructions in README
Correct instructions regarding Fedora Modular repos.
2019-01-26 19:11:37 +01:00
sharkdp
b68c5d8576 Bump minimum required Rust version to 1.30 2018-12-14 23:34:13 +01:00
David Peter
b1c865acaa Update README.md 2018-12-02 22:02:39 +01:00
Lavi Blumberg
d3d795ffb2 Removed confusing variable from examples in README.md
Removed confusing the variable `BAT_CONFIG_DIR` from examples because it
 is not a real configuration option for bat.
2018-12-02 20:19:12 +01:00
Keith Devens
6aa002850c Correct typo in readme 2018-11-26 20:11:25 +01:00
David Peter
bac1b16885
Consistent spelling of "color" 2018-11-18 12:11:07 +01:00
sh-tech
214cd0f8ea add link to original README 2018-11-15 08:53:03 +01:00
David Peter
26717b0cd2
Update README.md 2018-11-11 14:39:04 +01:00
David Peter
1f177f0a1c
Update README.md 2018-11-11 14:35:08 +01:00
David Peter
54c81fa543
Update README.md 2018-11-11 14:32:59 +01:00
David Peter
34dee9e3aa
Updates for README 2018-11-11 14:28:18 +01:00
David Peter
c073d4a118
Add new image 2018-11-11 13:19:34 +01:00
sharkdp
e79c5516bf Bump version, update assets 2018-11-11 12:55:38 +01:00
David Peter
5d5bf616ca
Update README.md 2018-11-11 12:17:15 +01:00
David Peter
d0ba5bcb32 Wording 2018-11-11 11:07:55 +01:00
Ricky
f8d39d5624 Resolving requested changes 2018-11-11 11:07:55 +01:00
Ricky
9998e2eac6 Initial commit of updated README for config file formatting 2018-11-11 11:07:55 +01:00
Dany Marcoux
bc21c4d0e0 Add openSUSE installation instructions 2018-11-06 19:21:33 +01:00
David Peter
b22a9f8fe3
Update README.md 2018-10-20 14:56:25 +02:00
David Peter
5219c40ed8
PAGER: Wrapper script is not needed anymore 2018-10-20 14:54:44 +02:00
David Peter
857cc215b4 Move link to header line 2018-10-19 22:00:05 +02:00
yobrave
481268f018 Doc: add Chinese readme link
#251
2018-10-19 22:00:05 +02:00
sharkdp
a892caeb33 Bump bat version to 0.8 2018-10-17 23:15:59 +02:00
sharkdp
314ec881ef Bump Rust version 2018-10-16 22:09:15 +02:00
Russ Taylor
eee7e5a575 Removes duplicate explanation. 2018-10-11 20:58:44 +02:00
Russ Taylor
ad7b634ee6 Fixes #328 - adds info for light backgrounds. 2018-10-11 20:58:44 +02:00
David Peter
1310f83c8d
Update Docker alias for bat 2018-10-11 20:57:46 +02:00
David Peter
897b9e7030
Add Docker instructions, closes #331 2018-10-11 20:05:17 +02:00
Merlin Göttlinger
504f28b3a1 Documented nix availability 2018-10-09 20:07:27 +02:00
David Peter
d83c93c805
Update README.md 2018-10-07 18:39:52 +02:00
sharkdp
1dbb4ef683 Update minimum Rust version to 1.27 2018-10-07 15:34:37 +02:00
sharkdp
e30e1bab2e Move theme-preview section into own paragraph 2018-10-06 21:12:12 +02:00
Russ Taylor
f140f6da46 Fixes #273 - describes 'musl' builds. 2018-10-06 21:07:01 +02:00
Grégoire Paris
3446fdf5f2 Document how to rapidly preview theme on a file 2018-10-06 21:06:31 +02:00
sharkdp
3456ce1187 Add a small tutorial 2018-09-26 18:08:24 +02:00
sharkdp
886a5b3d24 Document the situation with less and scrolling
closes #312
closes #246
2018-09-26 18:03:46 +02:00
sharkdp
238482e5f3 Update syntax-set, fixes #314 2018-09-23 10:30:19 +02:00
Katrin Leinweber
96b24d8a7e Fix typos 2018-09-20 19:16:51 +02:00
eth-p
254efac9c2 Added section to README on using Cygwin. 2018-09-14 18:30:43 +02:00
Jeroen Hoek
dcec322117 Update README (libz-dev may be required)
On Ubuntu 18.04 I had to install `cmake` as well as `libz-dev` to get
bat to compile.
2018-09-14 14:12:44 +02:00
Alexander Eimer
d781156327 Adds ansible install instructions for ansible to readme 2018-09-12 23:06:33 +02:00
sharkdp
732750c274 Bump version 2018-09-12 22:03:48 +02:00
sharkdp
54c434934e Bump version, update assets 2018-09-12 22:01:01 +02:00
sharkdp
bd619db3ca Mention BAT_STYLE in README.md 2018-09-12 21:57:54 +02:00
Aankhen
d6c8fee044 README.md: Add Using bat on Windows 2018-09-09 12:22:05 +02:00
sharkdp
f88eba6476 Add section concerning missing zlib-devel
closes #229
2018-09-05 21:13:43 +02:00
sharkdp
d2b4766f92 Small README update 2018-09-04 08:25:24 +02:00
Roald
5cf92b4f94 Windows download with scoop 2018-09-04 08:23:38 +02:00
sharkdp
67ec5fe2b7 Add OneHalf themes, closes #256 2018-09-03 22:12:41 +02:00
David Peter
532fb921a6
Update README.md 2018-09-01 00:59:30 +02:00
sharkdp
ba4d5a2e7d Bump version number 2018-09-01 00:30:43 +02:00
David Peter
c7cce0752b Add AppVeyor badge 2018-08-31 23:57:27 +02:00
sharkdp
839e4ee611 Bump version 2018-08-28 23:21:35 +02:00
sharkdp
08e6db1581 Add Troubleshooting section
see #220
2018-08-28 22:08:34 +02:00
sharkdp
4d08ecd828 Fix headline levels 2018-08-28 21:04:41 +02:00
sharkdp
28e1d0e613 Add development section to README 2018-08-28 21:03:03 +02:00
sharkdp
d11839ad03 Update install instructions 2018-08-28 20:55:15 +02:00
sharkdp
052425b12f Load customized themes in addition to defaults
- New themes in `$BAT_CONFIG_DIR/themes` are now loaded *in addition* to
  the default themes (they may also override).
- The `Default.tmTheme` symlink is not necessary anymore.

This relates to #172
2018-08-20 21:39:21 +02:00
sharkdp
1dddce3aa1 Separate syntax set and theme set
This commit separates the handling of syntax sets and theme sets. It
also changes the way how new syntax definitions are loaded from `bat`'s
configuration folder. New syntax definitions are now loaded *in
addition* to the ones that are stored in the `bat` binary by default.

This fixes #172
2018-08-19 11:08:23 +02:00
sharkdp
e5b8c4471a Bump minimum required rust version 2018-08-18 21:30:12 +02:00
sharkdp
a6d6c28723 Add documentation on new pager-customization 2018-08-18 20:22:11 +02:00
sharkdp
94ccc646e8 Update README 2018-07-23 21:58:06 +02:00
David Peter
8b92aae23f
Fix Travis link 2018-07-17 23:37:03 +02:00
Conrad Kleinespel
50209bfe21 updates archlinux install instructions 2018-06-08 16:15:27 +02:00
Ezinwa Okpoechi
69c798eafd Fix command typo 2018-06-01 17:01:28 +02:00
sharkdp
bf5883f06f Updates for 0.4 2018-05-31 22:57:18 +02:00
David Peter
a7f4f202cb
Update README.md 2018-05-30 21:32:40 +02:00
David Peter
397223374a
Add TOC 2018-05-30 21:23:24 +02:00
David Peter
0c2da90fa4
Change color of crates.io badge 2018-05-30 21:10:14 +02:00
David Peter
fe29da6e76
Add license badge 2018-05-30 21:02:40 +02:00
sharkdp
9d92350cbb Use default Markdown syntax, closes #157 2018-05-30 20:40:02 +02:00
sharkdp
5ee8913538 Add logo header to README 2018-05-22 22:39:20 +02:00
sharkdp
17b37fedcb Add project goals and list of alternatives 2018-05-21 00:28:30 +02:00
sharkdp
145b99f01c Include syntaxes and themes in repository
This changes a few things:

- All syntaxes and themes are now stored (as submodules) under
  assets/syntaxes and assets/themes

- The default directories for syntaxes and themes are "syntaxes"
  and "themes" (used to be "syntax" and "themes")

- The "bat cache" command can now take a `--source <dir>` and
  `--target <dir>` option.

- The cached files have been renamed to "themes.bin" and "syntaxes.bin"
2018-05-16 22:04:12 +02:00
Mateusz Piotrowski
9af1d2b891 Add FreeBSD installation instructions
Closes #41.
2018-05-16 20:25:14 +02:00
sharkdp
13a53d230b Add MacOS install instructions, closes #33 2018-05-10 12:35:07 +02:00
David Peter
fdeb98e859
Add usage examples 2018-05-09 00:33:49 +02:00
David Peter
6a417886aa
Add comment about paging & concatenation 2018-05-09 00:12:25 +02:00
sharkdp
ef7c39b159 Improve cache subcommand
* Remove the old `init-cache` subcommand

* Introduce a new `cache` subcommand that can be used like this:

    * `bat cache -h` - Show help
    * `bat cache --init` - Initialize cache from config dir
    * `bat cache --clear` - Reset the cache
    * `bat cache --config-dir` - Show config directory

* Update README

closes #44
2018-05-08 20:11:25 +02:00
sharkdp
da92154163 Re-format README 2018-05-07 20:06:01 +02:00
sharkdp
179bd4f525 Mention cmake in build instructions, closes #57 2018-05-07 20:03:56 +02:00
bspeice
21f9e2b0f7 Bump minimum required version to 1.24
#40
2018-05-03 08:22:31 +02:00
David Peter
92aa2b547e
Update README.md 2018-05-02 23:29:52 +02:00
sharkdp
65f66d0bee Small update to README 2018-05-02 22:21:56 +02:00
sharkdp
edbe8f3e1a Remove openssl dependency 2018-05-02 20:45:07 +02:00
Wesley Moore
8f18567f2d Add Arch Linux installation instructions to README 2018-05-01 10:04:14 +02:00