Rooba
/
lapce
mirror of https://github.com/lapce/lapce.git
1
1
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Reviewed and tidied changes

This commit is contained in:
Alexander Murphy 2022-05-30 21:42:32 +01:00
parent 854e240ad2
commit 943487b65c
2 changed files with 25 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
CONTRIBUTING.md
View File

@ -3,27 +3,25 @@ Thank you for your interest in contributing to Lapce! No contribution is too sma
## Feature Requests
A feature request is _something you want to be included in Lapce_. We track feature requests on GitHub via [issues](https://github.com/lapce/lapce/issues). There are generally two kinds of features:
A feature request is _something you want to have included in Lapce_. We track feature requests on GitHub via [issues](https://github.com/lapce/lapce/issues). There are generally two kinds of features:
1. A feature more suited to the core development of Lapce. If this is the case please make a suggestion in a new [issues](https://github.com/lapce/lapce/issues).
2. A feature that is more suited to a Plugin. We currently have an issue to track requests specifically for Plugins! You can view it, and make suggestions [here](https://github.com/lapce/lapce/issues/558).
1. A feature more suited to the core development of Lapce. If this is the case please make a suggestion in an [issue](https://github.com/lapce/lapce/issues).
2. A feature that is more suited to a Plugin. We currently have an issue to track requests specifically for Plugins! You can view the discussion and make suggestions [here](https://github.com/lapce/lapce/issues/558).
To reduce the number of duplicate requests, please search through the issues to see if something has already been suggested. If a feature you want has been suggested, then comment on that issue to let us know it's popular. You can use emoji-reactions to show us just how popular!
As always though, if you have any questions or are just not sure where to start, post a message into the [Discord](https://discord.gg/n8tGJ6Rn6D) server.
## Bug Reports
Bugs should also be reported on GitHub via [issues](https://github.com/lapce/lapce/issues). This allows us to track them and see how prevalent they are.
If you encounter a bug when using Lapce, check the issues to see if anyone else has encountered it. If it already exists, you can use emoji reactions to show you'd really like it to be fixed asap.
If you encounter a bug when using Lapce, check the issues to see if anyone else has encountered it. If it already exists, you can use emoji reactions to indicate it should be fixed ASAP!
## Pull Requests
If you want to write some code, develop the documentation, or otherwise work on a certain feature or bug, let us know by replying to, or creating an [issue](https://github.com/lapce/lapce/issues).
If you want to write some code, develop the documentation, or otherwise work on a certain feature or bug, let us know by replying to or creating an [issue](https://github.com/lapce/lapce/issues).
We are currently in the process of improving the documentation for new developers/code contributors. Feel free to get started, or post a message on [Discord](https://discord.gg/n8tGJ6Rn6D) to see what can be done.
## Contact
If you've got any questions about contributing, we suggest you start with [Discord](https://discord.gg/n8tGJ6Rn6D) to chat with many of Lapce's contributors and users.
As always, if you have any questions or are just not sure where to start, post a message into the [Discord](https://discord.gg/n8tGJ6Rn6D) server. We suggest you start here as it is the most popular way for Lapce's contributors and users to communicate.

29
README.md
View File

@ -24,14 +24,14 @@
<br/>
Lapce is written in pure Rust with a UI in [Druid](https://github.com/linebender/druid) (which is also written in Rust). It is designed with [Rope Science](https://xi-editor.io/docs/rope_science_00.html) from the [Xi-Editor](https://github.com/xi-editor/xi-editor) which makes for lightning-fast computation, and the [Wgpu Graphics API](https://github.com/gfx-rs/wgpu) for rendering. More information about the features of Lapce can be found on the [main website](https://lapce.dev), user documentation can be found on [GitBook](https://docs.lapce.dev/).
Lapce is written in pure Rust with a UI in [Druid](https://github.com/linebender/druid) (which is also written in Rust). It is designed with [Rope Science](https://xi-editor.io/docs/rope_science_00.html) from the [Xi-Editor](https://github.com/xi-editor/xi-editor) which makes for lightning-fast computation, and uses the [Wgpu Graphics API](https://github.com/gfx-rs/wgpu) for rendering. More information about the features of Lapce can be found on the [main website](https://lapce.dev) and user documentation can be found on [GitBook](https://docs.lapce.dev/).
![](https://github.com/lapce/lapce/blob/master/extra/images/screenshot.png?raw=true)
## Features
* Built-in LSP (Language Server Protocol) support to give you intelligent code features such as: completion, diagnostics and code actions
* Modal Editing (Vim-like) support as first class citizen (toggleable)
* Built-in LSP ([Language Server Protocol](https://microsoft.github.io/language-server-protocol/)) support to give you intelligent code features such as: completion, diagnostics and code actions
* Modal editing support as first class citizen (Vim-like, and toggleable)
* Built-in remote development support inspired by [VSCode Remote Development](https://code.visualstudio.com/docs/remote/remote-overview). Enjoy the benefits of a "local" experience, and seamlessly gain the full power of a remote system.
* Plugins can be written in programming languages that can compile to the [WASI](https://wasi.dev/) format (C, Rust, [AssemblyScript](https://www.assemblyscript.org/))
* Built-in terminal, so you can execute commands in your workspace, without leaving Lapce.
@ -40,18 +40,14 @@ Lapce is written in pure Rust with a UI in [Druid](https://github.com/linebender
Guidelines for contributing to Lapce can be found in [`CONTRIBUTING.md`](CONTRIBUTING.md).
## Build from source
## Building from source
It is easy to build Lapce from source on a GNU/Linux distribution. Cargo handles the build process, all you need to do, is ensure the correct dependencies are installed.
### Install the Rust compiler with `rustup`
1. If you haven't already, install the Rust compiler and Cargo using [`rustup.rs`](https://rustup.rs/).
2. Install dependencies for your operating system:
> If you use a different distribution, and are having trouble finding appropriate dependencies, let us know in an issue!
#### Ubuntu
```sh
sudo apt install cmake pkg-config libfontconfig-dev libgtk-3-dev
@ -60,10 +56,23 @@ sudo apt install cmake pkg-config libfontconfig-dev libgtk-3-dev
```sh
sudo dnf install gcc-c++ perl-FindBin perl-File-Compare gtk3-devel
```
3. Run the build command with the release flag
3. Clone this repository (this command will clone to your home directory):
```sh
git clone https://github.com/lapce/lapce.git ~/lapce
```
4. `cd` into the repository, and run the build command with the release flag
```sh
cd ~/lapce
```
```sh
cargo build --release
```
> If you use a different distribution, and are having trouble finding appropriate dependencies, let us know in an issue!
Once Lapce is compiled, the executable will be available in `target/release/lapce`.
## Feedback & Contact
@ -76,4 +85,4 @@ There is also a [Matrix Space](https://matrix.to/#/#lapce-editor:matrix.org), wh
## Licence
Lapce is released under the Apache License Version 2, which is an open source licence. You may contribute to this project, or use the code as you please as long as you adhere to the conditions. You can find a copy of the licence text within `LICENSE`.
Lapce is released under the Apache License Version 2, which is an open source licence. You may contribute to this project, or use the code as you please as long as you adhere to its conditions. You can find a copy of the licence text within `LICENSE`.