lapce/README.md

60 lines
2.3 KiB
Markdown
Raw Normal View History

2021-10-06 10:26:47 +00:00
<h1 align="center">
2022-03-04 17:28:46 +00:00
<a href="https://lapce.dev" target="_blank">
2021-10-06 10:41:00 +00:00
<img src="extra/images/logo.png" width=200 height=200/><br>
2021-10-06 10:26:47 +00:00
Lapce
2022-03-04 17:28:46 +00:00
</a>
2021-10-06 10:26:47 +00:00
</h1>
2021-09-17 11:00:04 +00:00
<h4 align="center">Lightning-fast and Powerful Code Editor written in Rust</h4>
2021-09-17 12:37:48 +00:00
2022-03-04 17:25:37 +00:00
<div align="center">
<a href="https://github.com/lapce/lapce/actions/workflows/cargo.yml" target="_blank">
<img src="https://github.com/lapce/lapce/actions/workflows/cargo.yml/badge.svg" />
</a>
2022-03-04 17:26:57 +00:00
<a href="https://discord.gg/n8tGJ6Rn6D" target="_blank">
2022-03-04 17:25:37 +00:00
<img src="https://img.shields.io/discord/946858761413328946?logo=discord" />
</a>
<a href="https://matrix.to/#/#lapce-editor:matrix.org" target="_blank">
<img src="https://img.shields.io/matrix/lapce-editor:matrix.org?color=turquoise&logo=Matrix" />
</a>
2022-03-04 17:26:57 +00:00
<a href="https://docs.lapce.dev" target="_blank">
2022-03-04 17:25:37 +00:00
<img src="https://img.shields.io/static/v1?label=Docs&message=docs.lapce.dev&color=blue" alt="Lapce Docs">
</a>
</div>
2022-03-04 17:52:42 +00:00
<br/>
2021-09-17 12:43:38 +00:00
2021-09-17 12:37:48 +00:00
2022-03-02 11:57:36 +00:00
Lapce is written in pure Rust, with UI in [Druid](https://github.com/linebender/druid). It's using [Xi-Editor](https://github.com/xi-editor/xi-editor)'s [Rope Science](https://xi-editor.io/docs/rope_science_00.html) for text editing, and using [Wgpu](https://github.com/gfx-rs/wgpu) for rendering. More information on the [website](https://lapce.dev).
2021-09-17 12:37:48 +00:00
2021-12-23 08:27:18 +00:00
![](https://github.com/lapce/lapce/blob/master/extra/images/screenshot.png?raw=true)
2022-01-04 14:43:27 +00:00
## Features
2021-09-17 12:37:48 +00:00
* Modal Editing (Vim like) support as first class citizen (can be turned off as well)
* Built in LSP support
2021-09-17 12:39:14 +00:00
* Built in remote development support (inspired by [VSCode Remote Development](https://code.visualstudio.com/docs/remote/remote-overview))
2021-09-17 12:37:48 +00:00
* Plugin can be written in programming languages that can compile to [WASI](https://wasi.dev/) (C, Rust, [AssemblyScript](https://www.assemblyscript.org/))
2021-10-18 14:18:28 +00:00
* Built in terminal
2022-01-04 14:43:27 +00:00
2022-01-04 15:13:57 +00:00
## Build from source
### Install the Rust compiler with `rustup`
1. Install [`rustup.rs`](https://rustup.rs/).
### Dependencies
#### Ubuntu
```sh
sudo apt-get install cmake pkg-config libfreetype6-dev libfontconfig1-dev libxcb-xfixes0-dev libxkbcommon-dev
```
### Building
```sh
cargo build --release
```
The exectuable will be available at `target/release/lapce`
2022-01-04 14:43:27 +00:00
## Feedback
2022-02-25 20:19:47 +00:00
* Chat on [Discord](https://discord.gg/n8tGJ6Rn6D)
2022-01-04 14:43:27 +00:00
* Join the discussion on [Reddit](https://www.reddit.com/r/lapce/)