2019-12-28 12:16:32 +01:00
|
|
|
# lite
|
2020-05-09 12:45:50 +02:00
|
|
|
|
2019-12-28 12:16:32 +01:00
|
|
|
|
|
|
|
|
A lightweight text editor written in Lua
|
|
|
|
|
|
2020-05-08 21:07:15 +02:00
|
|
|
* **[Get lite](https://github.com/rxi/lite/releases/latest)** — Download
|
|
|
|
|
for Windows and Linux
|
2020-07-19 10:55:23 +02:00
|
|
|
* **[Get started](doc/usage.md)** — A quick overview on how to get started
|
2020-05-08 21:07:15 +02:00
|
|
|
* **[Get plugins](https://github.com/rxi/lite-plugins)** — Add additional
|
|
|
|
|
functionality
|
|
|
|
|
* **[Get color themes](https://github.com/rxi/lite-colors)** — Add additional colors
|
|
|
|
|
themes
|
|
|
|
|
|
2019-12-28 12:16:32 +01:00
|
|
|
## Overview
|
|
|
|
|
lite is a lightweight text editor written mostly in Lua — it aims to provide
|
2020-05-08 21:07:15 +02:00
|
|
|
something practical, pretty, *small* and fast, implemented as simply as
|
2019-12-28 12:16:32 +01:00
|
|
|
possible; easy to modify and extend, or to use without doing either.
|
|
|
|
|
|
2020-05-08 21:07:15 +02:00
|
|
|
## Customization
|
|
|
|
|
Additional functionality can be added through plugins which are available from
|
|
|
|
|
the [plugins repository](https://github.com/rxi/lite-plugins); additional color
|
|
|
|
|
themes can be found in the [colors repository](https://github.com/rxi/lite-colors).
|
|
|
|
|
The editor can be customized by making changes to the
|
|
|
|
|
[user module](data/user/init.lua).
|
2019-12-28 12:16:32 +01:00
|
|
|
|
|
|
|
|
## Building
|
2021-02-19 19:40:34 +01:00
|
|
|
|
|
|
|
|
### Linux
|
|
|
|
|
|
|
|
|
|
You can build the project yourself on Linux with following prerequisites:
|
|
|
|
|
|
|
|
|
|
* GCC
|
|
|
|
|
* Simple DirectMedia Layer development files
|
|
|
|
|
|
|
|
|
|
#### Debian/Ubuntu
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
sudo apt install libsdl2-dev gcc
|
|
|
|
|
./build.sh
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### Windows
|
|
|
|
|
|
|
|
|
|
Using the `build.bat` script *([MinGW](https://nuwen.net/mingw.html) is required)*.
|
2020-10-03 14:49:14 +02:00
|
|
|
Note that the project does not need to be rebuilt if you are only making changes
|
|
|
|
|
to the Lua portion of the code.
|
2019-12-28 12:16:32 +01:00
|
|
|
|
|
|
|
|
## Contributing
|
|
|
|
|
Any additional functionality that can be added through a plugin should be done
|
2019-12-28 12:21:45 +01:00
|
|
|
so as a plugin, after which a pull request to the
|
|
|
|
|
[plugins repository](https://github.com/rxi/lite-plugins) can be made. In hopes
|
|
|
|
|
of remaining lightweight, pull requests adding additional functionality to the
|
|
|
|
|
core will likely not be merged. Bug reports and bug fixes are welcome.
|
2019-12-28 12:16:32 +01:00
|
|
|
|
|
|
|
|
## License
|
|
|
|
|
This project is free software; you can redistribute it and/or modify it under
|
|
|
|
|
the terms of the MIT license. See [LICENSE](LICENSE) for details.
|
