From a69409a36fb46b4730a7d23c64d426d7d20fa470 Mon Sep 17 00:00:00 2001 From: alice pellerin Date: Tue, 5 May 2026 15:36:07 -0500 Subject: [PATCH] update readme --- README.md | 25 +++++++------------------ todo.md | 2 ++ 2 files changed, 9 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index 75cd946..f8676a5 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# hexapoda +# [hexapoda](https://simonomi.dev/hexapoda) a colorful modal hex editor @@ -8,24 +8,13 @@ a colorful modal hex editor ## status -currently, hexapoda is very unpolished, and missing some major features. if you'd be interested in using it, please let me know! if enough people want, i'd be willing to make it more accessible and write some docs +still missing some notable features (see [todo.md](https://github.com/simonomi/hexapoda/blob/main/todo.md)), but ready for general use. visit [the website](https://simonomi.dev/hexapoda) for more detailed documentation -## features +## installation -- [color-codes bytes](https://simonomi.dev/blog/color-code-your-bytes) by value -- modal editing - - selection-first, like [Kakoune](https://kakoune.org) and [Helix](https://helix-editor.com) -- multiple selections - - split selection(s) into #-byte chunks -- undo/redo -- inspect the current selection(s) - - signed, unsigned, binary, fixed-point, UTF-8, color -- mark notable offsets -- jump to selected offset +- short answer: `cargo binstall hexapoda` or `cargo install hexapoda` +- [slightly longer answer](https://simonomi.dev/hexapoda/install) -### notable features that are missing (for now) +## config -- search -- diffing -- inserting bytes - - only replacing and deleting right now +see [https://simonomi.dev/hexapoda/config](https://simonomi.dev/hexapoda/config) diff --git a/todo.md b/todo.md index 298a523..f4fe8eb 100644 --- a/todo.md +++ b/todo.md @@ -7,6 +7,8 @@ - search - `/` hex, `A-/` ASCII - if non-hex-digit typed, search ASCII + - `A-*` repeat (entered number) times +- copy/paste (`y`/`p`) - inspector translations for varint [#1](https://github.com/simonomi/hexapoda/issues/1#issue-4232822634) - `M` mark at selected offset? (like `Jm`) - diffing