2019-12-28 12:16:32 +01:00
|
|
|
# lite
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
A lightweight text editor written in Lua
|
|
|
|
|
|
|
|
|
|
## Overview
|
|
|
|
|
lite is a lightweight text editor written mostly in Lua — it aims to provide
|
|
|
|
|
something practical, pretty, *small* and responsive, implemented as simply as
|
|
|
|
|
possible; easy to modify and extend, or to use without doing either.
|
|
|
|
|
|
|
|
|
|
## Get
|
2019-12-28 15:01:54 +01:00
|
|
|
Go to the [releases](https://github.com/rxi/lite/releases) page to download
|
|
|
|
|
precompiled binaries for Windows and Linux. Additional functionality can be
|
|
|
|
|
added through plugins which are available from the
|
|
|
|
|
[plugins repository](https://github.com/rxi/lite-plugins). 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
|
|
|
|
|
You can build the project yourself on Linux using the provided `build.py`
|
|
|
|
|
script. Note that the project does not need to be rebuilt if you are only making
|
|
|
|
|
changes to the Lua portion of the code.
|
|
|
|
|
|
|
|
|
|
## 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.
|
