limetext/lime
1
1
Fork 0
mirror of https://github.com/limetext/lime.git synced 2024-11-23 19:47:23 +03:00
Code Issues Projects Releases Wiki Activity
Page: Architectural Overview
Pages
Architectural Overview Building on Arch Linux Building on CentOS 7 Building on Debian Stretch Building on Fedora 21 Building on Raspberry Pi 2 and 3 Building on Ubuntu 14.04 Building on Ubuntu 16.04 Building on Vagrant Building on Windows Building on macOS Building Contributing FAQ Forking Goals HTML Architecture and Development Guide Home Implementing commands QML Architecture & Development Guide Quick notes on debugging a Go program with lldb Troubleshooting
25 Architectural Overview
Leonel edited this page 2020-04-03 14:58:27 -03:00
Table of Contents

Start with the Go Docs

The best place to start for understanding the LimeText architecture are the limetext godocs. As these docs are generated from source, it will continue to be the most up to date resource.

GoDoc

Basic Architecture

Lime has the following components:

  1. backend: This contains all the code which defines Lime itself, like Project, File, Window etc For more details refer backend's Github repo
  2. commands: They will be imported whenever the User does something like Open a new Project, save a file etc. For more details see commands' Github repo
  3. frontend: Users will use the lime text editor in one of its possibly many frontends, for instance the lime-qml.
  4. packages: They allow us to support multiple languages, their syntax highlighting, autocomplete etc

Frontends

HTML Architecture & Development Guide

QML Architecture & Development Guide

Backend

Getting Started

Your first resource for understanding the lime backend should be the godoc for the backend package.

"backend talks to frontend mostly through Frontend interface (it's not completed yet) and somehow the registered events but currently the frontend is free to import and use exported api of backend packages. There are some discussions on #281 about the api and other stuff."

-zoli