Skip to content

jesperkha/rum

Repository files navigation


Logo

Minimal editor for the Windows console
Latest release »

Screenshot

Rum editing its own source code

About

Rum is a fast and minimal editor that supports syntax highlighting, search, split buffers, tabs and much more! It is specifically made for the windows terminal using the win32 console API. It has no other dependencies than libc and win32, making it very lightweight (~70kb) and easy to build! See roadmap.md and changelog.md for progress on development, and the tutorial to get started.

Key features

  • Easy to use and install
  • Super lightweight
  • No dependencies, runs out of the box
  • Vim-like keybindings
  • Sane defaults
  • Split buffers and tabs
  • Syntax highlighting and themes
  • File explorer

Installation

Just install rum please

Download and run the installer. This will put rum in your Program Files folder and add it to the PATH environment variable. Then run it from anywhere with Command Prompt or Windows Terminal!

Or build from source

This requires mingw and gcc. Note that, when moving the executable to another location, you need to copy the config directory along with it.

git clone https://github.com/jesperkha/rum.git
cd rum
make release

Windows Only

rum is only for Windows at the moment. This will not change any time soon. rum was initially made to be a 100% Windows compatible terminal text editor with no dependencies. For this reason, rum is not designed to be cross platform, and there is little to no abstraction over OS specific code. Linux user can enjoy Vim for now...

Documentation and Help

Using the command :help will display all available commands in rum. You can also read the tutorial.