Skip to content

Latest commit

 

History

History
119 lines (78 loc) · 4.52 KB

README.md

File metadata and controls

119 lines (78 loc) · 4.52 KB
Raw

Helix

Build status GitHub Release Documentation GitHub contributors Matrix Space

Screenshot

A Kakoune / Neovim inspired editor, written in Rust.

The editing model is very heavily based on Kakoune; during development I found myself agreeing with most of Kakoune's design decisions.

For more information, see the website or documentation.

All shortcuts/keymaps can be found in the documentation on the website.

Troubleshooting

Features

  • Vim-like modal editing
  • Multiple selections
  • Built-in language server support
  • Smart, incremental syntax highlighting and code editing via tree-sitter

Although it's primarily a terminal-based editor, I am interested in exploring a custom renderer (similar to Emacs) using wgpu or skulpin.

Note: Only certain languages have indentation definitions at the moment. Check runtime/queries/<lang>/ for indents.scm.

Installation

Installation documentation.

Packaging status

ARMv6l Support

This fork is my (@NeilPandya) attempt to get Helix working on my Raspberry Pi Zero Wireless. I'm not sure if there're pre-existing branches dedicated towards legacy 32-bit ARM support, but I'm not aware of any. After some poking around, I'm not sure if this will ever be merged upstream, but I'm documenting my progress here.

Building for 32-bit ARM

I'm using a Raspberry Pi Zero Wireless, which is a 32-bit ARMv6l device. I'm not sure if this will work on other devices; this is fork is solely meant for Raspberry Pi Zero Wireless devices.

Prerequisites

I'm using buildx to build the container. I've included the Dockerfile and some convenience bash scripts to help with the build process. They will install the necessary packages and 32-bit libraries to build Helix.

Building

# Clone the repo
git clone https://github.com/NeilPandya/helix-armv6l.git

# Change into the directory
cd helix-armv6l

# Change the -t argument to whatever you want to name the image; I have helix here, but you can use nano or any editor of your choice to change it.
hx ./build-image.sh

# Build the image
./build-image.sh

# Alter the ./run-container.sh script to use the image you just built.
hx ./run-container.sh

# Run the container
./run-container.sh
# Once inside the container, build Helix
./build-helix-armv6l.sh
# Once Helix is built, you can exit the container and copy the binary to your device.
exit

# Copy the binary to your device
scp ./target/arm-unknown-linux-gnueabi/release/hx <your-username>@<your-device-ip>:/home/<your-username>/hx

# SSH into your device
ssh <your-username>@<your-device-ip>

# Change permissions and ownership of the binary
chmod 755 -v./hx && chown root:root ./hx

# Move the binary to /usr/local/bin
sudo mv -v ./hx /usr/local/bin/hx

Contributing

Contributing guidelines can be found here.

Getting help

Your question might already be answered on the FAQ.

Discuss the project on the community Matrix Space (make sure to join #helix-editor:matrix.org if you're on a client that doesn't support Matrix Spaces yet).

Credits

Thanks to @jakenvac for designing the logo!