README.md 3.7 KB
Newer Older
F
Fredrik Ehnbom 已提交
1 2 3
[![Build Status](https://travis-ci.org/limetext/lime.svg?branch=master)](https://travis-ci.org/limetext/lime)
[![Coverage Status](https://img.shields.io/coveralls/limetext/lime.svg?branch=master)](https://coveralls.io/r/limetext/lime?branch=master)
[![GoDoc](https://godoc.org/github.com/limetext/lime?status.svg)](https://godoc.org/github.com/limetext/lime)
F
Felix Laurie von Massenbach 已提交
4
[![Bug Reports](https://badge.waffle.io/limetext/lime.svg?label=bug&title=bug%20reports)](http://waffle.io/limetext/lime)
5

F
Felix Laurie von Massenbach 已提交
6

7
# Status
8

9
The [frontends](https://github.com/limetext/lime/issues?direction=desc&labels=frontend) are **not** ready to replace your favourite editor, but the backend itself isn't too far away.
10

11
[Your help is needed](https://github.com/limetext/lime#contributing) to move the project forward! Claim an [issue](https://github.com/limetext/lime/issues) as your own and submit a pull request!
12 13


14
# What is Lime?
F
Felix Laurie von Massenbach 已提交
15

16
![Screenshot taken Aug 27 2014](http://limetext.org/assets/img/screen.png)
F
Fredrik Ehnbom 已提交
17

F
Felix Laurie von Massenbach 已提交
18 19 20 21 22 23 24 25
> I love the [Sublime Text](http://www.sublimetext.com) editor. [I have](https://github.com/quarnster/SublimeClang) [created](https://github.com/quarnster/SublimeJava) [several](https://github.com/quarnster/CompleteSharp) [plugins](https://github.com/quarnster/SublimeGDB) [to make](https://github.com/quarnster/ADBView) it even better. One thing that scares me though is that it is not open sourced and the [pace of nightly releases](http://www.sublimetext.com/nightly) 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

F
Felix Laurie von Massenbach 已提交
26

F
Felix Laurie von Massenbach 已提交
27
### Why API compatibility?
28

F
Felix Laurie von Massenbach 已提交
29
Sublime Text has a good plugin architecture and a [large collection of existing plugins](https://sublime.wbond.net/) created for it. We want users to be able to take advantage of these extensions without requiring developers to support multiple APIs.
30

F
Felix Laurie von Massenbach 已提交
31

F
Fredrik Ehnbom 已提交
32 33
# Goals

F
Fredrik Ehnbom 已提交
34
Please refer to the [Goals](https://github.com/limetext/lime/wiki/Goals) page in the [wiki](https://github.com/limetext/lime/wiki/_pages).
J
jaseg 已提交
35

F
Felix Laurie von Massenbach 已提交
36

F
Fredrik Ehnbom 已提交
37 38
# Build instructions

F
Fredrik Ehnbom 已提交
39
Please refer to the [Building](https://github.com/limetext/lime/wiki/Building) page in the [wiki](https://github.com/limetext/lime/wiki/_pages).
F
Fredrik Ehnbom 已提交
40

R
RoelVanNyen 已提交
41 42

# Contributing
F
Felix Laurie von Massenbach 已提交
43 44

Want to hack on Lime? Awesome! Here are instructions to get you started. They are probably not perfect, so please let us know if anything feels wrong or incomplete.
R
RoelVanNyen 已提交
45 46 47 48 49

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.

50
Where is a good place to start? The [Contributing](https://github.com/limetext/lime/wiki/Contributing) page in the [wiki](https://github.com/limetext/lime/wiki/_pages) has some suggestions.
R
RoelVanNyen 已提交
51

O
Orhan Küçükyılmaz 已提交
52
# Website and IRC channel
F
Felix Laurie von Massenbach 已提交
53

O
Orhan Küçükyılmaz 已提交
54 55 56 57
Website: [limetext.org](http://limetext.org)

IRC: [\#limetext](http://webchat.freenode.net/?channels=limetext)

F
Felix Laurie von Massenbach 已提交
58

F
Fredrik Ehnbom 已提交
59 60
# License

F
Fredrik Ehnbom 已提交
61
The license of the project is the [2-clause BSD license](https://github.com/limetext/lime/blob/master/LICENSE).