parent
b028231aea
commit
5c7cec9f85
4 changed files with 74 additions and 2 deletions
2
Cargo.lock
generated
2
Cargo.lock
generated
|
@ -10327,7 +10327,7 @@ dependencies = [
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "tree-sitter-nu"
|
name = "tree-sitter-nu"
|
||||||
version = "0.0.1"
|
version = "0.0.1"
|
||||||
source = "git+https://github.com/nushell/tree-sitter-nu?rev=26bbaecda0039df4067861ab38ea8ea169f7f5aa#26bbaecda0039df4067861ab38ea8ea169f7f5aa"
|
source = "git+https://github.com/nushell/tree-sitter-nu?rev=7dd29f9616822e5fc259f5b4ae6c4ded9a71a132#7dd29f9616822e5fc259f5b4ae6c4ded9a71a132"
|
||||||
dependencies = [
|
dependencies = [
|
||||||
"cc",
|
"cc",
|
||||||
"tree-sitter",
|
"tree-sitter",
|
||||||
|
|
|
@ -21,7 +21,8 @@ brew install zed
|
||||||
|
|
||||||
## Developing Zed
|
## Developing Zed
|
||||||
|
|
||||||
- [Building Zed](./docs/src/developing_zed__building_zed.md)
|
- [Building Zed for macOS](./docs/src/developing_zed__building_zed_macos.md)
|
||||||
|
- [Building Zed for Linux](./docs/src/developing_zed__building_zed_linux.md)
|
||||||
- [Running Collaboration Locally](./docs/src/developing_zed__local_collaboration.md)
|
- [Running Collaboration Locally](./docs/src/developing_zed__local_collaboration.md)
|
||||||
|
|
||||||
## Contributing
|
## Contributing
|
||||||
|
|
71
docs/src/developing_zed__building_zed_linux.md
Normal file
71
docs/src/developing_zed__building_zed_linux.md
Normal file
|
@ -0,0 +1,71 @@
|
||||||
|
# Building Zed
|
||||||
|
|
||||||
|
## Repository
|
||||||
|
|
||||||
|
After cloning the repository, ensure all git submodules are initialized:
|
||||||
|
|
||||||
|
```shell
|
||||||
|
git submodule update --init --recursive
|
||||||
|
```
|
||||||
|
|
||||||
|
## Dependencies
|
||||||
|
|
||||||
|
- Install [Rust](https://www.rust-lang.org/tools/install)
|
||||||
|
|
||||||
|
- Install the Rust wasm toolchain:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
rustup target add wasm32-wasi
|
||||||
|
```
|
||||||
|
|
||||||
|
- Install the necessary system libraries:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
script/linux
|
||||||
|
```
|
||||||
|
|
||||||
|
- If you prefer to install the system libraries manually, you can find the list of required packages in the `script/linux` file.
|
||||||
|
|
||||||
|
|
||||||
|
## Backend Dependencies
|
||||||
|
|
||||||
|
# Note: This section is still in development. The instructions are not yet complete.
|
||||||
|
|
||||||
|
If you are developing collaborative features of Zed, you'll need to install the dependencies of zed's `collab` server:
|
||||||
|
|
||||||
|
- Install [Postgres](https://www.postgresql.org/download/linux/)
|
||||||
|
- Install [Livekit](https://github.com/livekit/livekit-cli) and [Foreman](https://theforeman.org/manuals/3.9/quickstart_guide.html)
|
||||||
|
|
||||||
|
Alternatively, if you have [Docker](https://www.docker.com/) installed you can bring up all the `collab` dependencies using Docker Compose:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
docker compose up -d
|
||||||
|
```
|
||||||
|
|
||||||
|
## Building Zed from Source
|
||||||
|
|
||||||
|
Once you have the dependencies installed, you can build Zed using [Cargo](https://doc.rust-lang.org/cargo/).
|
||||||
|
|
||||||
|
For a debug build:
|
||||||
|
|
||||||
|
```
|
||||||
|
cargo run
|
||||||
|
```
|
||||||
|
|
||||||
|
For a release build:
|
||||||
|
|
||||||
|
```
|
||||||
|
cargo run --release
|
||||||
|
```
|
||||||
|
|
||||||
|
And to run the tests:
|
||||||
|
|
||||||
|
```
|
||||||
|
cargo test --workspace
|
||||||
|
```
|
||||||
|
|
||||||
|
## Troubleshooting
|
||||||
|
|
||||||
|
### Cargo errors claiming that a dependency is using unstable features
|
||||||
|
|
||||||
|
Try `cargo clean` and `cargo build`.
|
Loading…
Add table
Add a link
Reference in a new issue