Skip to content

Commit

Permalink
update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
d1y committed Oct 23, 2024
1 parent 93b52a0 commit 90740f3
Showing 1 changed file with 18 additions and 43 deletions.
61 changes: 18 additions & 43 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,43 +1,18 @@
# Zed

[![CI](https://github.com/zed-industries/zed/actions/workflows/ci.yml/badge.svg)](https://github.com/zed-industries/zed/actions/workflows/ci.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

<a href="https://repology.org/project/zed-editor/versions">
<img src="https://repology.org/badge/vertical-allrepos/zed-editor.svg?minversion=0.143.5" alt="Packaging status" align="right">
</a>

On macOS and Linux 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:

- Windows ([tracking issue](https://github.com/zed-industries/zed/issues/5394))
- 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).
# Zed Unstable

Fork https://github.com/zed-industries/zed, 主要为了使用一些官方拒绝的或未合并的PR(比较激进?)

```sh
./script/bundle-mac -l -i
```

- [Background Image Support](https://github.com/zed-industries/zed/discussions/11086)
- [Add file icons to editor tabs](https://github.com/zed-industries/zed/pull/12443)
- [Show Icons for Completion Kind](https://github.com/zed-industries/zed/pull/10056)
- [Add comment syntax highlighting support](https://github.com/zed-industries/zed/pull/9082)
- [Fix suffix match filename](https://github.com/zed-industries/zed/pull/10969)
- [feat: file_finder match ">" redirect to command_palette](https://github.com/zed-industries/zed/pull/8704)
- [zed:OpenLog support highlights](https://github.com/zed-industries/zed/pull/9946)
- [Revert bun icon](https://github.com/zed-industries/zed/pull/10965)
- [Update gohper file type icon](https://github.com/zed-industries/zed/pull/7069)
- [Use document window animation for “normal” windows](https://github.com/zed-industries/zed/pull/10477)

0 comments on commit 90740f3

Please sign in to comment.