From 335c307b93480ac3fc1addcd444e1a26817683ab Mon Sep 17 00:00:00 2001 From: Marshall Bowers Date: Fri, 3 May 2024 19:53:22 -0400 Subject: [PATCH] Fix README links (#11382) 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 --- README.md | 100 ++++++++++---------- docs/src/development/local-collaboration.md | 2 +- 2 files changed, 51 insertions(+), 51 deletions(-) diff --git a/README.md b/README.md index 0951616afe..a5ae33d0db 100644 --- a/README.md +++ b/README.md @@ -1,50 +1,50 @@ -# 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 - -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): - -- Linux ([tracking issue](https://github.com/zed-industries/zed/issues/7015)) -- Windows ([tracking issue](https://github.com/zed-industries/zed/issues/5394)) -- Web ([tracking issue](https://github.com/zed-industries/zed/issues/5396)) - -For macOS users, you can also install Zed using [Homebrew](https://brew.sh/): - -```sh -brew install --cask zed -``` - -Alternatively, to install the Preview release: - -```sh -brew install --cask zed@preview -``` - -## Developing Zed - -- [Building Zed for macOS](./docs/src/developing_zed__building_zed_macos.md) -- [Building Zed for Linux](./docs/src/developing_zed__building_zed_linux.md) -- [Building Zed for Windows](./docs/src/developing_zed__building_zed_windows.md) -- [Running Collaboration Locally](./docs/src/developing_zed__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 + +[![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 + +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): + +- Linux ([tracking issue](https://github.com/zed-industries/zed/issues/7015)) +- Windows ([tracking issue](https://github.com/zed-industries/zed/issues/5394)) +- Web ([tracking issue](https://github.com/zed-industries/zed/issues/5396)) + +For macOS users, you can also install Zed using [Homebrew](https://brew.sh/): + +```sh +brew install --cask zed +``` + +Alternatively, to install the Preview release: + +```sh +brew install --cask zed@preview +``` + +## 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). diff --git a/docs/src/development/local-collaboration.md b/docs/src/development/local-collaboration.md index fa47ee9a27..60e619c39a 100644 --- a/docs/src/development/local-collaboration.md +++ b/docs/src/development/local-collaboration.md @@ -1,6 +1,6 @@ # 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