From 6a06bbc12d1084ab5ced40442c98da7bdcaa5bf1 Mon Sep 17 00:00:00 2001 From: Adam Date: Tue, 11 Oct 2022 20:38:45 -0400 Subject: Update README.md --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/README.md b/README.md index c3b1312..e9bff0d 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,22 @@ +# 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 file directly into your user directory colors folder: + * 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 -- cgit v1.2.3