aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/README.md b/README.md
index c3b1312..42228bb 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,21 @@
+# Lite XL colors
+
Color themes for the [Lite XL text editor](https://github.com/lite-xl/lite-xl), originally forked from the [lite colors repository](https://github.com/rxi/lite-colors).
+## How to install
+
+To install a color scheme, drop the `.lua` file directly into:
+
+* Linux `~/.config/lite-xl/colors/`
+* MacOS `~/.config/lite-xl/colors/`
+* Windows `C:\Users\(username)\.config\lite-xl\colors\`
+
+Then, add a call to `core.reload_module` to your user module (the gear in the bottom left corner). As an example, if you installed the `github_dark.lua` file into your colors folder, you'd load it with:
+
+```lua
+core.reload_module("colors.github_dark")
+```
+
*Note: if you make a pull request, the relevant table should be updated and kept
in alphabetical order. The [`make_preview_image.lua`](make_preview_image.lua)
script should be used to create a preview image for your theme which should be