git.iko.soy/bat
on master help sign in
Minor README improvements
commitbf78b74db4274361d2d6eb4746e1c77667b99255 authorsharkdp <davidpeter@web.de> dateWed 14 Oct 2020, 08:24 (6 years ago) parentf80fba4
2 files changed+17−13
compare with master
unifiedsplit
README.md+10−6 doc/assets.md+7−7
README.md+10−6
@@ -391,12 +391,16 @@ variable to make these changes permanent or use `bat`s
391391
392392### Adding new syntaxes / language definitions
393393
394−Should you find a particular syntax is not available within `bat`, you can follow these instructions to easily add new syntaxes to your current `bat` installation.
394+Should you find that a particular syntax is not available within `bat`, you can follow these
395+instructions to easily add new syntaxes to your current `bat` installation.
395396
396−By default, `bat` uses the excellent [`syntect`](https://github.com/trishume/syntect/)
397+`bat` uses the excellent [`syntect`](https://github.com/trishume/syntect/)
397398library for syntax highlighting. `syntect` can read any
398399[Sublime Text `.sublime-syntax` file](https://www.sublimetext.com/docs/3/syntax.html)
399−and theme.
400+and theme.
401+
402+A good resource for finding Sublime Syntax packages is [Package Control](https://packagecontrol.io/). Once you found a
403+syntax:
400404
4014051. Create a folder with syntax definition files:
402406
@@ -423,9 +427,9 @@ If you ever want to go back to the default settings, call:
423427bat cache --clear
424428```
425429
426−4. If you think that a specific syntax should be included in `bat` by default, please
427− consider opening a "syntax request" ticket after reading the policies and
428− instructions [here](doc/assets.md)
430+4. If you think that a specific syntax should be included in `bat` by default, please
431+ consider opening a "syntax request" ticket after reading the policies and
432+ instructions [here](doc/assets.md): [Open Syntax Request](https://github.com/sharkdp/bat/issues/new?labels=syntax-request&template=syntax_request.md).
429433
430434### Adding new themes
431435
doc/assets.md+7−7
@@ -1,7 +1,7 @@
1−## Add New Syntax Highlighting into the bat binary
1+## Adding new builtin languages for syntax highlighting
2+
3+Should you find that a particular syntax is not available within `bat` and think it should be included in `bat` by default, you can follow the instructions outlined below.
24
3−Should you find a particular syntax is not available within `bat` and think it should be included in `bat` by default, you can follow the instructions and policies outlined below.
4−
55`bat` uses the excellent [syntect](https://github.com/trishume/syntect) library to highlight source
66code. As a basis, syntect uses [Sublime Text](https://www.sublimetext.com/) syntax definitions
77in the `.sublime-syntax` format.
@@ -31,6 +31,10 @@ in the `.sublime-syntax` format.
3131Make sure that the local cache does not interfere with the internally stored syntaxes and
3232themes (`bat cache --clear`).
3333
34+## Criteria for inclusion of new syntaxes
35+
36+* More than 10,000 downloads on packagecontrol.io/
37+
3438### Manual modifications
3539
3640The following files have been manually modified after converting from a `.tmLanguage` file:
@@ -54,7 +58,3 @@ The following files have been manually modified after converting from a `.tmLang
5458 https://github.com/seanjames777/SML-Language-Definition/blob/master/sml.tmLanguage
5559* `Cabal.sublime_syntax` has been added manually from
5660 https://github.com/SublimeHaskell/SublimeHaskell/ - we don't want to include the whole submodule because it includes other syntaxes ("Haskell improved") as well.
57−
58−## Criteria for inclusion of new syntaxes
59−
60−* More than 10,000 downloads on packagecontrol.io/