on master help sign in
Add project goals and list of alternatives
commit17b37fedcb70ab42dfb2e6b866fe6cf04adda8b9 authorsharkdp <davidpeter@web.de> dateMon 21 May 2018, 00:28 (8 years ago) parent1013cdd
2 files changed+30
README.md+12 doc/alternatives.md+18
README.md+12
@@ -157,3 +157,15 @@ If you ever want to go back to the default settings, call:
157157``` bash
158158bat cache --clear
159159```
160+
161+## Project goals and alternatives
162+
163+`bat` tries to achieve the following goals:
164+
165+- Provide beautiful, advanced syntax highlighting
166+- Integrate with Git to show file modifications
167+- Be a drop-in replacement for (POSIX) `cat`
168+- Offer a user-friendly command-line interface
169+
170+There are a lot of alternatives, if you are looking for similar programs. See
171+[this document](doc/alternatives.md) for a comparison.
doc/alternatives.mdnew file+18
@@ -0,0 +1,18 @@
1+# Alternatives
2+
3+The following table tries to give an overview *from `bat`s perspective*, i.e. we only compare
4+categories which are relevant for `bat`. Some of these projects have completely different goals and
5+if you are not looking for a program like `bat`, this comparison might not be for you.
6+
7+| | bat | [pygments](http://pygments.org/) | [highlight](http://www.andre-simon.de/doku/highlight/highlight.php) | [ccat](https://github.com/jingweno/ccat) | [source-highlight](https://www.gnu.org/software/src-highlite/) | [hicat](https://github.com/rstacruz/hicat) |
8+|----------------------------------------------|---------------------------------------------------------------------|----------------------------------|---------------------------------------------------------------------|------------------------------------------|----------------------------------------------------------------|-----------------------------------------------------|
9+| Drop-in `cat` replacement | (:heavy_check_mark:) [*](https://github.com/sharkdp/bat/issues/134) | :x: | :x: | (:heavy_check_mark:) | :x: | :x: [*](https://github.com/rstacruz/hicat/issues/6) |
10+| Git integration | :heavy_check_mark: | :x: | :x: | :x: | :x: | :x: |
11+| Automatic paging | :heavy_check_mark: | :x: | :x: | :x: | :x: | :heavy_check_mark: |
12+| Languages (circa) | 60 | 300 | 200 | 7 | 80 | 130 |
13+| Extensible (languages, themes) | :heavy_check_mark: | (:heavy_check_mark:) | (:heavy_check_mark:) | :x: | (:heavy_check_mark:) | :x: |
14+| Advanced highlighting (e.g. nested syntaxes) | :heavy_check_mark: | :heavy_check_mark: | (:heavy_check_mark:) ? | :x: | :heavy_check_mark: | :heavy_check_mark: |
15+| Execution time [ms] (`jquery-3.3.1.js`) | 624 | 789 | 400 | 80 | 300 | 316 |
16+
17+If you think that some entries in this table are outdated or wrong, please open a ticket or pull
18+request.