zed-industries/zed
1
1
Fork 0
mirror of https://github.com/zed-industries/zed.git synced 2024-09-18 18:08:07 +03:00
Code Issues Packages Projects Releases Wiki Activity

Fix README links (#11382)

Browse Source 
This PR fixes the links in the README to account for the changes in the
docs structure.

Also, somehow the README had gotten added with `\r\n` newlines, so I
changed it back to `\n` newlines.

Release Notes:

- N/A
This commit is contained in:
Marshall Bowers 2024-05-03 19:53:22 -04:00 committed by GitHub
parent 02a859fb08
commit 335c307b93
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 51 additions and 51 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

100
README.md
View File

@ -1,50 +1,50 @@
# Zed # Zed
[![CI](https://github.com/zed-industries/zed/actions/workflows/ci.yml/badge.svg)](https://github.com/zed-industries/zed/actions/workflows/ci.yml) [![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). 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 ## Installation
You can [download](https://zed.dev/download) Zed today for macOS (v10.15+). You can [download](https://zed.dev/download) Zed today for macOS (v10.15+).
Support for additional platforms is on our [roadmap](https://zed.dev/roadmap): Support for additional platforms is on our [roadmap](https://zed.dev/roadmap):
- Linux ([tracking issue](https://github.com/zed-industries/zed/issues/7015)) - Linux ([tracking issue](https://github.com/zed-industries/zed/issues/7015))
- Windows ([tracking issue](https://github.com/zed-industries/zed/issues/5394)) - Windows ([tracking issue](https://github.com/zed-industries/zed/issues/5394))
- Web ([tracking issue](https://github.com/zed-industries/zed/issues/5396)) - Web ([tracking issue](https://github.com/zed-industries/zed/issues/5396))
For macOS users, you can also install Zed using [Homebrew](https://brew.sh/): For macOS users, you can also install Zed using [Homebrew](https://brew.sh/):
```sh ```sh
brew install --cask zed brew install --cask zed
``` ```
Alternatively, to install the Preview release: Alternatively, to install the Preview release:
```sh ```sh
brew install --cask zed@preview brew install --cask zed@preview
``` ```
## Developing Zed ## Developing Zed
- [Building Zed for macOS](./docs/src/developing_zed__building_zed_macos.md) - [Building Zed for macOS](./docs/src/development/macos.md)
- [Building Zed for Linux](./docs/src/developing_zed__building_zed_linux.md) - [Building Zed for Linux](./docs/src/development/linux.md)
- [Building Zed for Windows](./docs/src/developing_zed__building_zed_windows.md) - [Building Zed for Windows](./docs/src/development/windows.md)
- [Running Collaboration Locally](./docs/src/developing_zed__local_collaboration.md) - [Running Collaboration Locally](./docs/src/development/local-collaboration.md)
## Contributing ## Contributing
See [CONTRIBUTING.md](./CONTRIBUTING.md) for ways you can contribute to Zed. 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. Also... we're hiring! Check out our [jobs](https://zed.dev/jobs) page for open roles.
## Licensing ## Licensing
License information for third party dependencies must be correctly provided for CI to pass. 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: 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 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 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). - 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).

2
docs/src/development/local-collaboration.md
View File

@ -1,6 +1,6 @@
# Local Collaboration # Local Collaboration
First, make sure you've installed Zed's [backend dependencies](./developing_zed__building_zed.md#backend-dependencies). First, make sure you've installed Zed's [backend dependencies](../developing-zed.md#backend-dependencies).
## Database setup ## Database setup