diff options
| author | Adam <adamdharrison@gmail.com> | 2022-10-11 20:50:13 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-10-11 20:50:13 -0400 |
| commit | b2451583149151575aafbceb04845bc0249ad7ab (patch) | |
| tree | ae63cd83caec1f11af6e086d639ac9f5999ee838 /README.md | |
| parent | 7eafe25eb953190c0513a2839124e3c4512208b7 (diff) | |
| parent | abf50150a7fc750dec1a13c7d60f84ced60c1980 (diff) | |
| download | lite-xl-colors-b2451583149151575aafbceb04845bc0249ad7ab.tar.gz lite-xl-colors-b2451583149151575aafbceb04845bc0249ad7ab.zip | |
Merge pull request #16 from lite-xl/install-instructions
Update README.md to include install instructions.
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 16 |
1 files changed, 16 insertions, 0 deletions
@@ -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 |