Go to file
Francesco 04be76e150
Create changelog.md
2020-06-28 18:25:40 +02:00
.github Create FUNDING.yml 2020-06-18 16:48:05 +01:00
data Merge remote-tracking branch 'rxi/master' into agg-font-renderer 2020-06-21 12:02:03 +02:00
lib/font_renderer Add execution flags to build script 2020-06-18 19:28:06 +02:00
src Merge remote-tracking branch 'rxi/master' into agg-font-renderer 2020-06-16 15:00:47 +02:00
.gitattributes Added `icon.inl linguist-vendored` to .gitattributes 2020-05-10 15:54:09 +01:00
.gitignore Fix and improve build script 2020-06-18 15:53:31 +02:00
LICENSE Updated copyright year; 2019 => 2020 2020-01-01 16:00:39 +00:00
README.md Fix typo in README 2020-06-21 23:54:51 +02:00
build-package-meson.sh Adapt build package script for Windows using MSYS2 2020-06-21 23:58:18 +02:00
build.sh Fix and improve build script 2020-06-18 15:53:31 +02:00
build_release.sh Replaced `build.py/build.config.py` with `build.sh` 2020-05-09 11:01:28 +01:00
changelog.md Create changelog.md 2020-06-28 18:25:40 +02:00
icon.ico Updated icon 2020-05-09 11:33:16 +01:00
icon.inl Updated icon 2020-05-09 11:33:16 +01:00
meson.build Fix meson build to request lua5.2 2020-06-17 20:27:59 +02:00
res.rc Initial commit 2019-12-28 11:17:56 +00:00

README.md

Lite XL

screenshot-dark

A lightweight text editor written in Lua, adapted from Lite

Overview

Lite XL 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 the font rendering and reduce CPU usage.

Customization

Additional functionality can be added through plugins which are available from the plugins repository; additional color themes can be found in the colors repository. The editor can be customized by making changes to the user module.

Building

You can build the project yourself on Linux using the provided build.sh script or using the Meson build.

The following libraries are required:

  • freetype2
  • libagg
  • SDL2
  • Lua 5.2

On a debian based system the required library and Meson can be installed using the commands:

# To install the required libraries:
sudo apt install libfreetype6-dev libagg-dev libsdl2-dev liblua5.2-dev

# To install Meson:
sudo apt install meson
# or pip3 install --user meson

To build Lite XL with Meson use the commands:

# configure
meson setup build

# build
ninja -C build

# install
ninja -C build install

Contributing

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

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

License

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