Skip to content

Commit

Permalink
docs: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
vyfor committed Dec 27, 2024
1 parent 006f3a4 commit 653c13d
Showing 1 changed file with 10 additions and 5 deletions.
15 changes: 10 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@

## πŸ“š Table of Contents
- [πŸ’Ž Features](#-features)
- [πŸ“¦ Installation](#-installation)
- [πŸ“¦ Install](#-install)
- [🎨 Themes](#-themes)
- [πŸ“– Documentation](#-documentation)
- [🀝 Contributing](#-contributing)
Expand All @@ -32,18 +32,23 @@
- 🌍 **Cross-Platform** β€” Supports Windows, Linux (Flatpak/Snap), macOS, and BSD.
- 🌸 **Rich Icon Collection** β€” Features over 70 uniquely designed icons.

## πŸ“¦ Installation
## πŸ“¦ Install

### Considerations
<details>
<summary>Expand</summary>

Cord requires the server executables to be present. To get it, you can either:
- **Fetch from GitHub**: By invoking `:Cord fetch` (async, recommended)
- Requires **[`curl`](https://curl.se)**
- **Build and install from crates.io**: By invoking `:Cord build` (async)
- Requires **[`Rust`](https://www.rust-lang.org/tools/install) >= 1.85.0 nightly**
- **Build from source**: By invoking `cargo b --release`, Cord will automatically move the executable.
- **Build from source**: By invoking `cargo b --release` and then manually moving the resulting binary to `nvim-data-dir/cord/bin`
- Requires **[`Rust`](https://www.rust-lang.org/tools/install) >= 1.85.0 nightly**
- **Download from GitHub**: Get latest release from https://github.com/vyfor/cord.nvim/releases/latest, rename it to cord[.exe] and place it under `nvim-data-dir/cord/bin`

</details>

### Installation
<details>
<summary>Using lazy.nvim</summary>
Expand Down Expand Up @@ -80,12 +85,12 @@ use {

**Unix:**
```bash
git clone https://github.com/vyfor/cord.nvim.git ~/.local/share/nvim/site/pack/plugins/start/cord.nvim
git clone -b client-server --single-branch https://github.com/vyfor/cord.nvim ~/.local/share/nvim/site/pack/plugins/start/cord.nvim
```

**Windows:**
```powershell
git clone https://github.com/vyfor/cord.nvim.git $LOCALAPPDATA/nvim-data/site/pack/plugins/start/cord.nvim
git clone -b client-server --single-branch https://github.com/vyfor/cord.nvim $LOCALAPPDATA/nvim-data/site/pack/plugins/start/cord.nvim
```

Then call the following function somewhere in your configuration:
Expand Down

0 comments on commit 653c13d

Please sign in to comment.