https://github.com/jesperkha/rum

Minimal editor for the Windows console
https://github.com/jesperkha/rum

c editor makefile no-dependencies terminal win32api windows

Last synced: about 4 hours ago
JSON representation

Minimal editor for the Windows console

• Host: GitHub
• URL: https://github.com/jesperkha/rum
• Owner: jesperkha
• License: mit
• Created: 2023-10-29T17:01:42.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-10-28T12:37:02.000Z (11 days ago)
• Last Synced: 2024-10-28T16:17:21.246Z (11 days ago)
• Topics: c, editor, makefile, no-dependencies, terminal, win32api, windows
• Language: C
• Homepage:
• Size: 1.95 MB
• Stars: 6
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: changelog.md
  • License: LICENSE
  • Roadmap: roadmap.md

Awesome Lists containing this project

README

        





  


  


    Minimal editor for the Windows console

    


    Latest release »

    


    


  







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](roadmap.md) and [changelog.md](changelog.md) for progress on development, and [the tutorial](tutorial.md) 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.](https://github.com/jesperkha/rum/releases/latest) 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](tutorial.md).