Back
gh

microsoft/edit: We all edit.

We all edit. Contribute to microsoft/edit development by creating an account on GitHub.

by microsoft github.com 427 words
View original

Edit

A simple editor for simple needs.

This editor pays homage to the classic 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

Installation

Packaging status

You can also download binaries from our Releases page.

Windows

You can install the latest version with WinGet:

winget install Microsoft.Edit

Build Instructions

Build Configuration

During compilation you can set various environment variables to configure the build. The following table lists the available configuration options:

Environment variableDescription
EDIT_CFG_ICU*See ICU library name (SONAME) for details.
EDIT_CFG_LANGUAGESA comma-separated list of languages to include in the build. See i18n/edit.toml for available languages.

Notes to Package Maintainers

Package Naming

The canonical executable name is “edit” and the alternative name is “msedit”. We’re aware of the potential conflict of “edit” with existing commands and recommend alternatively naming packages and executables “msedit”. Names such as “ms-edit” should be avoided. Assigning an “edit” alias is recommended, if possible.

ICU library name (SONAME)

This project optionally depends on the ICU library for its Search and Replace functionality. By default, the project will look for a SONAME without version suffix:

If your installation uses a different SONAME, please set the following environment variable at build time:

Additionally, this project assumes that the ICU exports are exported without _ prefix and without version suffix, such as u_errorName. If your installation uses versioned exports, please set:

Finally, you can set the following environment variables:

To test your settings, run cargo test again but with the --ignored flag. For instance:

cargo test -- --ignored