README.md 4.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
[![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

9
# Status
10

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

13 14 15 16 17
If you want to help us build Lime, great! We'd love your help. See [here](https://github.com/limetext/lime#contributing) 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](https://github.com/limetext/lime/wiki/_pages) or your search engine of choice. If you still need help, consider opening an issue in [limetext/support](https://github.com/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](https://github.com/limetext/lime/issues) and submit a pull request!
18 19


20
# What is Lime?
F
Felix Laurie von Massenbach 已提交
21

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

F
Felix Laurie von Massenbach 已提交
24 25 26 27 28 29 30 31
> 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 已提交
32

F
Felix Laurie von Massenbach 已提交
33
### Why API compatibility?
34

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

F
Felix Laurie von Massenbach 已提交
37

F
Fredrik Ehnbom 已提交
38 39
# Goals

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

F
Felix Laurie von Massenbach 已提交
42

F
Fredrik Ehnbom 已提交
43 44
# Build instructions

F
Fredrik Ehnbom 已提交
45
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 已提交
46

R
RoelVanNyen 已提交
47 48

# Contributing
F
Felix Laurie von Massenbach 已提交
49

50
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.
R
RoelVanNyen 已提交
51 52 53

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.

54 55 56
Where is a good place to start? The [Contributing](https://github.com/limetext/lime/wiki/Contributing) page in the wiki has some suggestions. Think the [wiki](https://github.com/limetext/lime/wiki/_pages) needs clarifying, or something is missing? Go ahead and make the change.

Guidelines for making contributions can be found in [CONTRIBUTING.md](https://github.com/limetext/lime/blob/master/CONTRIBUTING.md).
R
RoelVanNyen 已提交
57

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

F
Felix Laurie von Massenbach 已提交
60

F
Fredrik Ehnbom 已提交
61 62
# License

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