README
¶
Status
The frontends are not ready to replace your favourite editor, but the backend itself isn't too far away.
If you want to help us build Lime, great! We'd love your help. See here for how you could be most useful.
This project is not yet ready for daily use, and we currently lack the resource to support users. If you are in need of help building, running, or otherwise using Lime, try the wiki or your search engine of choice. If you still need help, consider opening an issue in limetext/support. Issues opened in this project that don't relate to bugs or improvements will be closed.
Your help is needed to move the project forward! Claim an issue and submit a pull request!
What is Lime?
I love the Sublime Text editor. I have created several plugins to make it even better. One thing that scares me though is that it is not open sourced and the pace of nightly releases have recently been anything but nightly, even now that version 3 is out in Beta.
There was a period of about 6 months after the Sublime Text 2 "stable" version was released where pretty much nothing at all was communicated to the users about what to expect in the future, nor was there much support offered in the forums. People including myself were wondering if the product was dead and I personally wondered what would happen to all the bugs, crashes and annoyances that still existed in ST2. This lack of communication is a dealbreaker to me and I decided that I will not spend any more money on that product because of it.
As none of the other text editors I've tried come close to the love I had for Sublime Text, I decided I had to create my own.
-- @quarnster
Why API compatibility?
Sublime Text has a good plugin architecture and a large collection of existing plugins created for it. We want users to be able to take advantage of these extensions without requiring developers to support multiple APIs.
Goals
Please refer to the Goals page in the wiki.
Build instructions
Please refer to the Building page in the wiki.
Contributing
Want to help build Lime? Awesome! We are always thrilled to receive pull requests, and do our best to process them as fast as possible. Not sure if that typo is worth a pull request? Do it! We will appreciate it.
If your pull request is not accepted on the first try, don't be discouraged! If there's a problem with the implementation, hopefully you received feedback on what to improve.
Where is a good place to start? The Contributing page in the wiki has some suggestions. Think the wiki needs clarifying, or something is missing? Go ahead and make the change.
Guidelines for making contributions can be found in CONTRIBUTING.md.
Want to chat? Find us on Gitter.
License
The license of the project is the 2-clause BSD license.
Directories
¶
| Path | Synopsis |
|---|---|
|
The backend package defines the very soul of Lime.
|
The backend package defines the very soul of Lime. |
|
commands
This package implements a couple of standard commands available to the editor.
|
This package implements a couple of standard commands available to the editor. |
|
render
The render package defines interfaces and functions to stylize a View's contents with colours, fonts and other metadata.
|
The render package defines interfaces and functions to stylize a View's contents with colours, fonts and other metadata. |
|
sublime
This package enables support for Sublime Text 3 python plugins and is an optional import for frontends.
|
This package enables support for Sublime Text 3 python plugins and is an optional import for frontends. |
|
textmate
This package enables support for Textmate Language Syntax definitions (tmLanguage) and Textmate Colour Schemes (tmTheme).
|
This package enables support for Textmate Language Syntax definitions (tmLanguage) and Textmate Colour Schemes (tmTheme). |
|
util
Contains various utility functions.
|
Contains various utility functions. |
|
tasks
|
|