aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorGuldoman <giulio.lettieri@gmail.com>2022-04-22 23:49:36 +0200
committerGuldoman <giulio.lettieri@gmail.com>2022-04-22 23:49:36 +0200
commita236f4ba55e98870eef103b706f2fa729f252325 (patch)
treed5bbfab974f33af1e48220226187ff8bcb3a4881 /README.md
parenta13bd0838104a7edc3fd91f5b98c5d2b17d1284e (diff)
downloadlite-xl-plugins-a236f4ba55e98870eef103b706f2fa729f252325.tar.gz
lite-xl-plugins-a236f4ba55e98870eef103b706f2fa729f252325.zip
Add plugin install instructions
Diffstat (limited to 'README.md')
-rw-r--r--README.md8
1 files changed, 6 insertions, 2 deletions
diff --git a/README.md b/README.md
index aa8eca1..ad0d549 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,11 @@
Plugins for the [Lite XL text editor](https://github.com/lite-xl/lite-xl), originally forked from the [lite plugins repository](https://github.com/rxi/lite-plugins).
-To install a plugin, go to your OS's config folder then to the folder 'lite-xl/plugins'
-(on Linux: '~/.config/lite-xl/plugins') and simply paste the '.lua' file in there.
+To install a plugin:
+- If the plugin links to a repository, follow its `README`.
+- If the plugin is a single file, drop it directly in:
+ - Linux `~/.config/lite-xl/plugins/`
+ - MacOS `~/.config/lite-xl/plugins/`
+ - Windows `C:\\Users\\(username)\\.config\\lite-xl\\plugins\\`
*Note: if you make a pull request, the table should be updated and kept in
alphabetical order. If your plugin is large (or you'd otherwise prefer it to