From bf78b74db4274361d2d6eb4746e1c77667b99255 Mon Sep 17 00:00:00 2001 From: sharkdp Date: Wed, 14 Oct 2020 08:24:20 +0200 Subject: [PATCH] Minor README improvements --- README.md | 16 ++++++++++------ doc/assets.md | 14 +++++++------- 2 files changed, 17 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 522a4535..a3a1e8dc 100644 --- a/README.md +++ b/README.md @@ -391,12 +391,16 @@ variable to make these changes permanent or use `bat`s ### Adding new syntaxes / language definitions -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. +Should you find that a particular syntax is not available within `bat`, you can follow these +instructions to easily add new syntaxes to your current `bat` installation. -By default, `bat` uses the excellent [`syntect`](https://github.com/trishume/syntect/) +`bat` uses the excellent [`syntect`](https://github.com/trishume/syntect/) library for syntax highlighting. `syntect` can read any [Sublime Text `.sublime-syntax` file](https://www.sublimetext.com/docs/3/syntax.html) -and theme. +and theme. + +A good resource for finding Sublime Syntax packages is [Package Control](https://packagecontrol.io/). Once you found a +syntax: 1. Create a folder with syntax definition files: @@ -423,9 +427,9 @@ If you ever want to go back to the default settings, call: bat cache --clear ``` -4. If you think that a specific syntax should be included in `bat` by default, please - consider opening a "syntax request" ticket after reading the policies and - instructions [here](doc/assets.md) +4. If you think that a specific syntax should be included in `bat` by default, please + consider opening a "syntax request" ticket after reading the policies and + instructions [here](doc/assets.md): [Open Syntax Request](https://github.com/sharkdp/bat/issues/new?labels=syntax-request&template=syntax_request.md). ### Adding new themes diff --git a/doc/assets.md b/doc/assets.md index 20da7f55..b70603de 100644 --- a/doc/assets.md +++ b/doc/assets.md @@ -1,7 +1,7 @@ -## Add New Syntax Highlighting into the bat binary +## Adding new builtin languages for syntax highlighting + +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. -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. - `bat` uses the excellent [syntect](https://github.com/trishume/syntect) library to highlight source code. As a basis, syntect uses [Sublime Text](https://www.sublimetext.com/) syntax definitions in the `.sublime-syntax` format. @@ -31,6 +31,10 @@ in the `.sublime-syntax` format. Make sure that the local cache does not interfere with the internally stored syntaxes and themes (`bat cache --clear`). +## Criteria for inclusion of new syntaxes + +* More than 10,000 downloads on packagecontrol.io/ + ### Manual modifications The 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 https://github.com/seanjames777/SML-Language-Definition/blob/master/sml.tmLanguage * `Cabal.sublime_syntax` has been added manually from https://github.com/SublimeHaskell/SublimeHaskell/ - we don't want to include the whole submodule because it includes other syntaxes ("Haskell improved") as well. - -## Criteria for inclusion of new syntaxes - -* More than 10,000 downloads on packagecontrol.io/ \ No newline at end of file