- rur User Guide
- Build and Launch rur
Build and Launch rur
By the end of this chapter, you will have built the current Linux editor and opened its startup screen.
Prepare the Tools
Use Linux, Rust 1.98 or a compatible toolchain, CRuby 3.4.10 with matching headers and shared library, a C compiler, libclang, Git, and Make. Ruby gems are not required. The development prerequisites explain how to inspect the selected Ruby executable and native libraries.
The current installation path is a source build. A packaged editor download
is not provided by this guide. Use a UTF-8 terminal whose TERM identifies
an xterm, screen, or tmux family. Input and output must use the same terminal.
Build and Open the Editor
From a shell:
git clone https://forge.adrianpk.com/rur/rur.git
cd rur
make run
make run compiles the development executable and loads
the example configuration.
The first build also compiles native dependencies. Later launches reuse the
build products.
The startup screen offers Open..., New Buffer, Open Project, and Open Workspace. Use Up/Down and Enter to select an action. Ctrl-G cancels an unfinished prompt. For now, press Ctrl-Q to leave without creating a document.
Open a File Directly
The following chapters use the development binary through Cargo, from the repository root:
env -u RUBYOPT -u RUBYLIB -u GEM_HOME -u GEM_PATH \
cargo run --locked -p rur-editor --bin rur-terminal-proof -- \
--profile nonmodal notes.txt
An absent final filename creates a live empty buffer; Save creates the file.
Its parent directory must already exist. The env prefix clears Ruby startup
overrides rejected by the embedded runtime.
Without --config, the editor selects the personal configuration described in
Personal Configuration. A fresh
installation without a personal source uses factory behavior. An explicit
--config path/to/init.rb selects trusted Ruby source for that launch.
If startup fails, check the tool versions, terminal family, and input/output attachment using Run the Terminal Proof. A rejected startup does not establish a successful editor session.
Previous: Getting Started | Part | User Guide | Next: Edit Your First File