diff --git a/README.md b/README.md index d1e2a75bec..23ce982213 100644 --- a/README.md +++ b/README.md @@ -1,39 +1,3 @@ -# Zed +# gpui - Community Edition -[![Zed](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/zed-industries/zed/main/assets/badge/v0.json)](https://zed.dev) -[![CI](https://github.com/zed-industries/zed/actions/workflows/run_tests.yml/badge.svg)](https://github.com/zed-industries/zed/actions/workflows/run_tests.yml) - -Welcome to Zed, a high-performance, multiplayer code editor from the creators of [Atom](https://github.com/atom/atom) and [Tree-sitter](https://github.com/tree-sitter/tree-sitter). - ---- - -### Installation - -On macOS, Linux, and Windows you can [download Zed directly](https://zed.dev/download) or [install Zed via your local package manager](https://zed.dev/docs/linux#installing-via-a-package-manager). - -Other platforms are not yet available: - -- Web ([tracking issue](https://github.com/zed-industries/zed/issues/5396)) - -### Developing Zed - -- [Building Zed for macOS](./docs/src/development/macos.md) -- [Building Zed for Linux](./docs/src/development/linux.md) -- [Building Zed for Windows](./docs/src/development/windows.md) -- [Running Collaboration Locally](./docs/src/development/local-collaboration.md) - -### Contributing - -See [CONTRIBUTING.md](./CONTRIBUTING.md) for ways you can contribute to Zed. - -Also... we're hiring! Check out our [jobs](https://zed.dev/jobs) page for open roles. - -### Licensing - -License information for third party dependencies must be correctly provided for CI to pass. - -We use [`cargo-about`](https://github.com/EmbarkStudios/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](https://embarkstudios.github.io/cargo-about/cli/generate/config.html#crate-configuration). +A community fork of [GPUI](https://gpui.rs), Zed's GPU-accelerated UI framework.