mirror of https://github.com/zed-industries/zed.git synced 2024-12-28 20:01:33 +00:00

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

gpui text-editor zed

Find a file

Mikayla Maki 54c04a6618 Fix race condition in diff base initializaiton (#2513 ) fixes https://linear.app/zed-industries/issue/Z-1657/diff-markers-in-gutter-do-not-show-up-until-after-first-save Release Notes: - Fixes a race condition on buffer initialization that would cause git diffs to not load.		2023-05-22 18:43:59 -07:00
.github	Update pull_request_template.md	2023-05-22 15:00:57 -04:00
.vscode
assets	Switch back to	2023-05-22 12:16:47 -07:00
crates	Add run until parked for test	2023-05-22 18:40:12 -07:00
plugins
script	Indent all release note lines for each PR	2023-05-22 14:44:05 -04:00
styles	Fixed contrast in project panel and scrollbar	2023-05-22 15:51:31 -07:00
.dockerignore
.gitignore
.gitmodules
Cargo.lock	Replace remaining usages of glob crate with globset	2023-05-19 09:36:46 -07:00
Cargo.toml	Replace remaining usages of glob crate with globset	2023-05-19 09:36:46 -07:00
Dockerfile
Procfile
README.md

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.