diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 30 |
1 files changed, 30 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 00000000..2f9752ad --- /dev/null +++ b/README.md @@ -0,0 +1,30 @@ +# 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 +Go to the [Releases](#TODO) page to download precompiled binaries for Windows or +Linux. Additional functionality can be added through plugins which are available +from the [plugins repository](#TODO). + +## 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 +so as a plugin, after which a pull request to the [plugins repository](#TODO) +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. + +## 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. |