Skip to content

Commit

Permalink
chore(README): add explanation
Browse files Browse the repository at this point in the history
  • Loading branch information
myypo committed Oct 6, 2024
1 parent 2473958 commit 0f8e692
Showing 1 changed file with 19 additions and 1 deletion.
20 changes: 19 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,22 @@
<!-- panvimdoc-ignore-start -->

<div align="center">
<h2>Experimental changes navigation plugin</h2>
<video width="95%" src="https://github.com/user-attachments/assets/6d0b4e03-435a-4600-89eb-84b49e7fa953"/>
</div>

## ❓ What is this and why?

Compass is an attempt to expand on the concept of `:h changelist` to allow:

- Chronological navigation between changes located in different files.
- Persisting change marks between vim sessions.
- Providing optional visual feedback and other ergonomics.
- Using recorded changes akin to builtin `:h mark`.

The end goal of the plugin is to improve codebase navigation in a way
that does not require proactive considerations on which location will be of interest later.

<!-- panvimdoc-ignore-end -->

## 🎯 Requirements
Expand All @@ -21,11 +38,12 @@
"myypo/compass.nvim",
build = "make",
event = "BufReadPost",
opts = {},
}
```

The plugin uses [nvim-oxi](https://github.com/noib3/nvim-oxi)
to make it possible to use Rust instead of lua/vimscript.
to make it possible to use rust instead of lua/vimscript.

The provided above installation snippet will download a pre-built by GitHub action library which should
work out of the box, but you can also build it yourself, provided, you have Rust toolchain installed.
Expand Down

0 comments on commit 0f8e692

Please sign in to comment.