summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorDan Davison <dandavison7@gmail.com>2019-10-13 10:09:21 -0700
committerDan Davison <dandavison7@gmail.com>2019-10-13 10:09:21 -0700
commit3280e66def4d41d7c8cb503c4e59a4eacd71268e (patch)
tree196a5f95a9d382001c4050c4359231e196fe2714 /README.md
parentf89300a69f531f630ff7e053b39ceddb9a6a3283 (diff)
Improve documentation for adding new theme/language
Diffstat (limited to 'README.md')
-rw-r--r--README.md9
1 files changed, 8 insertions, 1 deletions
diff --git a/README.md b/README.md
index 8a5eeba4..e27dc097 100644
--- a/README.md
+++ b/README.md
@@ -80,7 +80,14 @@ All git commands that display diff output should now display syntax-highlighted
## Supported languages and themes
-Delta supports the same languages and themes as [bat](https://github.com/sharkdp/bat), included here as the files `assets/syntaxes.bin` and `assets/themes.bin`. Please see the [bat](https://github.com/sharkdp/bat) documentation for instructions on how to create new versions of these files.
+To add new laguages/color themes to delta, the process is
+
+1. Clone the delta repo
+2. Create new versions of the files `assets/syntaxes.bin` and/or `assets/themes.bin`. Please see the [bat](https://github.com/sharkdp/bat#adding-new-syntaxes--language-definitions) documentation for instructions on how to create new versions of these files. You will need to copy them into the `assets/` directory of the delta git repo after creating them.
+3. Recompile delta: `cargo build --release`
+4. Now you have a new delta executable at `target/release/delta` that should feature your new language/theme (use `--list-languages` / `--list-themes` to check).
+
+Delta does not currently support reading these files dynamically from `~/.config` as `bat` does, but this is a feature that could be added.
## 24 bit color