mirror of https://github.com/zed-industries/zed.git synced 2024-09-20 02:47:34 +03:00

Code at the speed of thought – Zed is a high-performance, multiplayer code editor from the creators of Atom and Tree-sitter.

gpui starred-repo starred-zed-industries-repo text-editor zed

Go to file

Antonio Scandurra 2a8e0824a6 Fix opening excerpt when the cursor is at the end of a multi-buffer This was caused by seeking with a right bias, which in the case of the last excerpt in the buffer would seek past the end of the buffer. This commit changes the behavior to move the cursor back to the previous excerpt if we overshoot, to ensure we always land on an excerpt.		2023-05-24 15:02:57 +02:00
.github	Update pull_request_template.md	2023-05-22 15:00:57 -04:00
.vscode	Hit the local server when debugging	2021-08-24 17:11:40 -06:00
assets	Merge remote-tracking branch 'origin/main' into panels	2023-05-23 08:24:28 +02:00
crates	Fix opening excerpt when the cursor is at the end of a multi-buffer	2023-05-24 15:02:57 +02:00
plugins	Use the same serde version across the entire workspace	2023-03-28 09:42:00 -07:00
script	Indent all release note lines for each PR	2023-05-22 14:44:05 -04:00
styles	Improve styling of bottom and right docks	2023-05-23 09:02:45 +02:00
.dockerignore	Removed old experiments settings and staff mode flag, added new StaffMode global that is set based on the webserver's staff bit	2023-01-27 15:43:12 -08:00
.gitignore	Removed old experiments settings and staff mode flag, added new StaffMode global that is set based on the webserver's staff bit	2023-01-27 15:43:12 -08:00
.gitmodules	WIP: start on live_kit_server	2022-10-17 09:59:16 +02:00
Cargo.lock	Merge remote-tracking branch 'origin/main' into panels	2023-05-23 08:24:28 +02:00
Cargo.toml	Replace remaining usages of glob crate with globset	2023-05-19 09:36:46 -07:00
Dockerfile	Abort collaboration process if any thread panics	2023-01-27 09:50:59 +01:00
Procfile	Add livekit to the Procfile, update the README	2022-10-27 13:24:35 -07:00
README.md	Clarify GH Token scope requirements	2023-05-02 12:12:57 +03:00

README.md

Zed

Welcome to Zed, a lightning-fast, collaborative code editor that makes your dreams come true.

Development tips

Dependencies

Install Postgres.app and start it.
Install the LiveKit server and the foreman process supervisor:
```
brew install livekit
brew install foreman
```
Ensure the Zed.dev website is checked out in a sibling directory:
```
cd ..
git clone https://github.com/zed-industries/zed.dev
```

Initialize submodules

git submodule update --init --recursive

Set up a local zed database and seed it with some initial users:

Create a personal GitHub token to run script/bootstrap once successfully: the token needs to have an access to private repositories for the script to work (repo OAuth scope). Then delete that token.
```
GITHUB_TOKEN=<$token> script/bootstrap
```

Testing against locally-running servers

Start the web and collab servers:

foreman start

If you want to run Zed pointed at the local servers, you can run:

script/zed-with-local-servers
# or...
script/zed-with-local-servers --release

Dump element JSON

If you trigger cmd-alt-i, Zed will copy a JSON representation of the current window contents to the clipboard. You can paste this in a tool like DJSON to navigate the state of on-screen elements in a structured way.

Licensing

We use cargo-about to automatically comply with open source licenses. If CI is failing, check the following:

Is it showing a no license specified error for a crate you've created? If so, add publish = false under [package] in your crate's Cargo.toml.
Is the error failed to satisfy license requirements for a dependency? If so, first determine what license the project has and whether this system is sufficient to comply with this license's requirements. If you're unsure, ask a lawyer. Once you've verified that this system is acceptable add the license's SPDX identifier to the accepted array in script/licenses/zed-licenses.toml.
Is cargo-about unable to find the license for a dependency? If so, add a clarification field at the end of script/licenses/zed-licenses.toml, as specified in the cargo-about book.

Wasm Plugins

Zed has a Wasm-based plugin runtime which it currently uses to embed plugins. To compile Zed, you'll need to have the wasm32-wasi toolchain installed on your system. To install this toolchain, run:

rustup target add wasm32-wasi

Plugins can be found in the plugins folder in the root. For more information about how plugins work, check the Plugin Guide in crates/plugin_runtime/README.md.