zee

(β˜… 1,799)

A modern text editor for the terminal written in Rust

  • .gitignore
  • .rustfmt.toml
  • Cargo.lock
  • Cargo.toml
  • CHANGELOG.md
  • CONTRIBUTING.md
  • LICENSE-APACHE
  • LICENSE-MIT
  • README.md
  • TODO.md

# Installation Guide

1. Get the code
git clone https://github.com/zee-editor/zee

Downloads the entire project code from GitHub to your computer.

cd zee

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended
Prerequisites
  • Rust (rustup) Rust is required to use cargo.
  • APT (Debian/Ubuntu 계열) Built into Debian/Ubuntu-based Linux distributions.
cargo install --locked zee

Builds and installs the package published on crates.io β€” no need to clone the repo yourself.

cargo install --locked --features system-clipboard zee

Builds and installs the package published on crates.io β€” no need to clone the repo yourself.

sudo apt install xorg-dev libxcb-shape0-dev libxcb-xfixes0-dev

Installs directly from the APT package repository (Debian/Ubuntu-based).

cargo install --git https://github.com/zee-editor/zee

Builds and installs the package published on crates.io β€” no need to clone the repo yourself.

βœ… After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Rust

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Rust (rustup) Installing via rustup also installs cargo.
cargo install --locked zee

Builds and installs the package published on crates.io β€” no need to clone the repo yourself.

cargo install --locked --features system-clipboard zee

Builds and installs the package published on crates.io β€” no need to clone the repo yourself.

cargo install --git https://github.com/zee-editor/zee

Builds and installs the package published on crates.io β€” no need to clone the repo yourself.

cargo run -- zee/src/main.rs

Builds and then immediately runs the program.

ZEE_DISABLE_GRAMMAR_BUILD=t cargo run -- zee/src/main.rs

Builds and then immediately runs the program.

βœ… If cargo build finishes without errors, it worked. The executable is created under target/.

Pulled directly from this repo's README.

// repository documentation