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)
4
[![Bountysource](https://www.bountysource.com/badge/team?team_id=8742&style=raised)](https://www.bountysource.com/teams/limetext?utm_source=limetext&utm_medium=shield&utm_campaign=raised)
5

F
Felix Laurie von Massenbach 已提交
6
[![Gitter](https://badges.gitter.im/Join Chat.svg)](https://gitter.im/limetext/lime)
F
Felix Laurie von Massenbach 已提交
7

8
# Status
9

10
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.
11

12
[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!
13 14


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

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

F
Felix Laurie von Massenbach 已提交
19 20 21 22 23 24 25 26
> 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 已提交
27

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

F
Felix Laurie von Massenbach 已提交
30
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.
31

F
Felix Laurie von Massenbach 已提交
32

F
Fredrik Ehnbom 已提交
33 34
# Goals

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

F
Felix Laurie von Massenbach 已提交
37

F
Fredrik Ehnbom 已提交
38 39
# Build instructions

F
Fredrik Ehnbom 已提交
40
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 已提交
41

R
RoelVanNyen 已提交
42 43

# Contributing
F
Felix Laurie von Massenbach 已提交
44

F
Felix Laurie von Massenbach 已提交
45
Want to hack on 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.
R
RoelVanNyen 已提交
46 47 48

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.

49
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 已提交
50

51
Want to chat? Find us on [Gitter](https://gitter.im/limetext/lime).
O
Orhan Küçükyılmaz 已提交
52

F
Felix Laurie von Massenbach 已提交
53

F
Fredrik Ehnbom 已提交
54 55
# License

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