Go to file
Adam 590c8bb456
Merge pull request #759 from Jipok/again
Support for remaped special keys(Fix #757)
2021-12-21 19:56:33 -05:00
.github make labeler recursive 2021-11-10 08:12:27 +08:00
data Restores external pastes to be normal pastes. 2021-12-21 16:23:34 -05:00
docs Merge pull request #583 from takase1121/process-docs-update 2021-12-20 20:06:18 +08:00
lib/dmon Manual merge of into . 2021-11-23 15:57:22 -05:00
licenses Implement directory monitoring using septag/dmon 2021-10-08 21:31:22 +02:00
resources Merge branch 'master' into plugin_api_h_fix 2021-12-05 22:11:47 -05:00
scripts Directly link to our repo 2021-12-19 18:13:19 +01:00
src Support for remaped special keys(Fix #757) 2021-12-22 02:22:34 +05:00
subprojects Removed legacy reproc.wrap. 2021-12-20 18:35:24 -05:00
.editorconfig Updated Meson configuration 2021-08-09 22:26:16 +02:00
.gitattributes Merge pull request #309 from redtide/git-line-endings 2021-06-30 11:13:42 -04:00
.gitignore Subprojects. 2021-09-24 11:22:39 -04:00
LICENSE Switch to FiraSans and JetBrainsMono fonts 2021-05-22 15:09:54 +02:00
README.md Update README.md 2021-12-18 22:37:33 -05:00
build-packages.sh Bring back pgo option in new build package script 2021-09-05 15:43:22 +02:00
changelog.md Update changelog 2021-10-23 15:16:51 +02:00
meson.build Replace Reproc (#535) 2021-12-11 15:25:35 -05:00
meson_options.txt Adapt all scripts to work together with build-packages.sh 2021-09-05 15:23:08 +02:00

README.md

Lite XL

CI Discord Badge Image

screenshot-dark

A lightweight text editor written in Lua, adapted from lite.

Please refer to our website for the user and developer documentation, including build instructions details. A quick build guide is described below.

Lite XL has support for high DPI display on Windows and Linux and, since 1.16.7 release, it supports retina displays on macOS.

Please note that Lite XL is compatible with lite for most plugins and all color themes. We provide a separate lite-xl-plugins repository for Lite XL, because in some cases some adaptations may be needed to make them work better with Lite XL. The repository with modified plugins is https://github.com/lite-xl/lite-xl-plugins.

The changes and differences between Lite XL and rxi/lite are listed in the changelog.

Overview

Lite XL is derived from lite. It is a lightweight text editor written mostly in Lua — it aims to provide something practical, pretty, small and fast easy to modify and extend, or to use without doing either.

The aim of Lite XL compared to lite is to be more user friendly, improve the quality of font rendering, and reduce CPU usage.

Customization

Additional functionality can be added through plugins which are available in the [plugins repository] or in the Lite XL plugins repository.

Additional color themes can be found in the colors repository. These color themes are bundled with all releases of Lite XL by default.

Quick Build Guide

If you compile Lite XL yourself, it is recommended to use the script build-packages.sh:

bash build-packages.sh -h

The script will run Meson and create a tar compressed archive with the application or, for Windows, a zip file. Lite XL can be easily installed by unpacking the archive in any directory of your choice.

Otherwise the following is an example of basic commands if you want to customize the build:

meson setup --buildtype=release --prefix <prefix> build
meson compile -C build
DESTDIR="$(pwd)/lite-xl" meson install --skip-subprojects -C build

where <prefix> might be one of /, /usr or /opt, the default is /. To build a bundle application on macOS:

meson setup --buildtype=release --Dbundle=true --prefix / build
meson compile -C build
DESTDIR="$(pwd)/Lite XL.app" meson install --skip-subprojects -C build

Please note that the package is relocatable to any prefix and the option prefix affects only the place where the application is actually installed.

Installing Prebuilt

Head over to releases and download the version for your operating system.

Linux

Unzip the file and cd into the lite-xl directory:

tar -xzf <file>
cd lite-xl

To run lite-xl without installing:

cd bin
./lite-xl

To install lite-xl copy files over into appropriate directories:

mkdir -p $HOME/.local/bin && cp bin/lite-xl $HOME/.local/bin
cp -r share $HOME/.local

If $HOME/.local/bin is not in PATH:

echo -e 'export PATH=$PATH:$HOME/.local/bin' >> $HOME/.bashrc

To get the icon to show up in app launcher:

xdg-desktop-menu forceupdate

You may need to logout and login again to see icon in app launcher.

To uninstall just run:

rm -f $HOME/.local/bin/lite-xl
rm -rf $HOME/.local/share/icons/hicolor/scalable/apps/lite-xl.svg \
          $HOME/.local/share/applications/org.lite_xl.lite_xl.desktop \
          $HOME/.local/share/metainfo/org.lite_xl.lite_xl.appdata.xml \
          $HOME/.local/share/lite-xl

Contributing

Any additional functionality that can be added through a plugin should be done as a plugin, after which a pull request to the Lite XL plugins repository can be made.

Pull requests to improve or modify the editor itself are welcome.

Licenses

This project is free software; you can redistribute it and/or modify it under the terms of the MIT license. See LICENSE for details.

See the licenses file for details on licenses used by the required dependencies.