nix-dotfiles/pkgs/edit/README.md

23 lines
1 KiB
Markdown
Raw Permalink Normal View History

2025-05-23 12:19:11 -04:00
# ![Application Icon for Edit](./assets/edit.svg) Edit
A simple editor for simple needs.
This editor pays homage to the classic [MS-DOS Editor](https://en.wikipedia.org/wiki/MS-DOS_Editor), but with a modern interface and input controls similar to VS Code. The goal is to provide an accessible editor that even users largely unfamiliar with terminals can easily use.
![Screenshot of Edit with the About dialog in the foreground](./assets/edit_hero_image.png)
## Installation
* Download the latest release from our [releases page](https://github.com/microsoft/edit/releases/latest)
* Extract the archive
* Copy the `edit` binary to a directory in your `PATH`
* You may delete any other files in the archive if you don't need them
## Build Instructions
* [Install Rust](https://www.rust-lang.org/tools/install)
* Install the nightly toolchain: `rustup install nightly`
* Alternatively, set the environment variable `RUSTC_BOOTSTRAP=1`
* Clone the repository
* For a release build, run: `cargo build --config .cargo/release.toml --release`