diff options
author | Adam <adamdharrison@gmail.com> | 2022-10-11 20:38:45 -0400 |
---|---|---|
committer | GitHub <noreply@github.com> | 2022-10-11 20:38:45 -0400 |
commit | 6a06bbc12d1084ab5ced40442c98da7bdcaa5bf1 (patch) | |
tree | 9637f549baeecb8af52e5d15e5d6dcd2a2548287 | |
parent | 7eafe25eb953190c0513a2839124e3c4512208b7 (diff) | |
download | lite-xl-colors-6a06bbc12d1084ab5ced40442c98da7bdcaa5bf1.tar.gz lite-xl-colors-6a06bbc12d1084ab5ced40442c98da7bdcaa5bf1.zip |
Update README.md
-rw-r--r-- | README.md | 17 |
1 files changed, 17 insertions, 0 deletions
@@ -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 |