README.md 3.4 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)
4

F
Felix Laurie von Massenbach 已提交
5

6
# Status
7

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

10
[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!
11 12


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

15
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.
F
Fredrik Ehnbom 已提交
16

17
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.
F
Fredrik Ehnbom 已提交
18

19
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.
F
Fredrik Ehnbom 已提交
20

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

F
Felix Laurie von Massenbach 已提交
23

24 25 26 27
### Why create a clone?

Because I like the architecture of the extensibilities in the original editor.

F
Felix Laurie von Massenbach 已提交
28

F
Fredrik Ehnbom 已提交
29 30
# Goals

F
Fredrik Ehnbom 已提交
31
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 已提交
32

F
Felix Laurie von Massenbach 已提交
33

F
Fredrik Ehnbom 已提交
34 35
# Build instructions

F
Fredrik Ehnbom 已提交
36
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 已提交
37

R
RoelVanNyen 已提交
38 39

# Contributing
F
Felix Laurie von Massenbach 已提交
40 41

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 已提交
42 43 44 45 46

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.

47
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 已提交
48

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

O
Orhan Küçükyılmaz 已提交
51 52 53 54
Website: [limetext.org](http://limetext.org)

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

F
Felix Laurie von Massenbach 已提交
55

F
Fredrik Ehnbom 已提交
56 57
# License

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