Build and try

Run Fe on your Mac.在 Mac 上运行 Fe。

Build the native macOS app or terminal editor from a clean checkout.

从干净检出构建原生 macOS 应用或终端版。

Before you build

Use an Apple silicon Mac with Rustup, Python 3.9+, GNU awk, GNU Texinfo and pkg-config. For Cocoa bundling, use Xcode with Icon Composer support. The repository pins its Rust toolchain.

Follow the bootstrap guide for dependency details. Both builds generate resources from the checked-in sources.

Select the pinned Tree-sitter SDK

Run from the repository root. The install command prepares a separate prefix for Tree-sitter 0.27.1.

export FEMACS_TREE_SITTER_PREFIX="$PWD/build/tree-sitter-sdk"
python3 tools/toolchain-pins.py install --prefix "$FEMACS_TREE_SITTER_PREFIX"
export PKG_CONFIG_PATH="$FEMACS_TREE_SITTER_PREFIX/lib/pkgconfig"
pkg-config --modversion tree-sitter

Build and launch

Build and run the Cocoa app

Start with a clean profile using -Q.

cargo run -p xtask -- build-macos
dist/macos/Femacs.app/Contents/MacOS/Femacs -Q

Build and run the terminal editor

Launch inside your terminal without loading personal configuration.

cargo run -p xtask -- build-terminal
build/terminal/port/src/emacs -Q -nw

Verify existing builds

Build both products before running local acceptance. Choose a fresh result directory.

python3 tools/local-acceptance.py --out build/acceptance/local-run

Bundle and test

See the packaging guide for a movable app and local disk image. Local trial packages are ad hoc signed. See the testing guide for when to run Cocoa, input method and compatibility checks.