itsscb/harpoon
1
0
Fork 0
mirror of https://github.com/ThePrimeagen/harpoon.git synced 2025-07-13 17:40:25 +00:00
Code Issues Packages Projects Releases Wiki Activity

feat: README update

Browse Source
This commit is contained in:
Michael Paulson 2023-11-30 11:29:45 -07:00
parent c1aebbad9e
commit 6ebe49c10d
1 changed files with 15 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
README.md
View File

@ -1,5 +1,15 @@
<div align="center"> <div align="center">
## ⇁ HARPOON 2
This is a deprecated and all future changes will be to the branch `harpoon2`.
[Harpoon 2](https://github.com/ThePrimeagen/harpoon/tree/harpoon2)
**STATUS**: Merging into mainline April 20th or June 9th (nice)
-------------------------------
# Legacy Harpoon README
# Harpoon # Harpoon
##### Getting you where you want with the fewest keystrokes. ##### Getting you where you want with the fewest keystrokes.
@ -10,7 +20,6 @@
![Harpoon](harpoon.png) ![Harpoon](harpoon.png)
-- image provided by **Bob Rust** -- image provided by **Bob Rust**
## ⇁ WIP ## ⇁ WIP
This is not fully baked, though used by several people. If you experience any This is not fully baked, though used by several people. If you experience any
issues, see some improvement you think would be amazing, or just have some issues, see some improvement you think would be amazing, or just have some
@ -65,9 +74,9 @@ you can also cycle the list in both directions
:lua require("harpoon.ui").nav_next() -- navigates to next mark :lua require("harpoon.ui").nav_next() -- navigates to next mark
:lua require("harpoon.ui").nav_prev() -- navigates to previous mark :lua require("harpoon.ui").nav_prev() -- navigates to previous mark
``` ```
from the quickmenu, open a file in: from the quickmenu, open a file in:
a vertical split with control+v, a vertical split with control+v,
a horizontal split with control+x, a horizontal split with control+x,
a new tab with control+t a new tab with control+t
### Terminal Navigation ### Terminal Navigation
@ -233,11 +242,11 @@ vim.cmd('highlight! HarpoonNumberInactive guibg=NONE guifg=#7aa2f7')
vim.cmd('highlight! TabLineFill guibg=NONE guifg=white') vim.cmd('highlight! TabLineFill guibg=NONE guifg=white')
``` ```
Result: Result:
![tabline](https://i.imgur.com/8i8mKJD.png) ![tabline](https://i.imgur.com/8i8mKJD.png)
## ⇁ Social ## ⇁ Social
For questions about Harpoon, there's a #harpoon channel on [the Primagen's Discord](https://discord.gg/theprimeagen) server. For questions about Harpoon, there's a #harpoon channel on [the Primagen's Discord](https://discord.gg/theprimeagen) server.
* [Discord](https://discord.gg/theprimeagen) * [Discord](https://discord.gg/theprimeagen)
* [Twitch](https://www.twitch.tv/theprimeagen) * [Twitch](https://www.twitch.tv/theprimeagen)
* [Twitter](https://twitter.com/ThePrimeagen) * [Twitter](https://twitter.com/ThePrimeagen)