Splits Jump

Vim plugin for jumping between splits swiftly

---

• ⬆️ Top of Document

• 🏗️ Requirements

• ⚡ Quick Start

• 🧰 Usage

• 🗒 Notes

• 📈 Contributing

  • 🔱 Forking
  • 💱 Sponsor

• 📇 Attribution

• ⚖️ Licensing

---

Requirements

This repository requires the Vim text editor to be installed the source code is available on GitHub -- vim/vim, and most GNU Linux package managers are able to install Vim directly, eg...

• Arch based Operating Systems

sudo packman -Syy

sudo packman -S gawk make vim

• Debian derived Distributions

sudo apt-get update

sudo apt-get install gawk make vim

Note gawk and make are only required if not utilizing a Vim plugin manager.

---

Quick Start

Clone this project...

mkdir -vp ~/git/hub/vim-utilities

cd ~/git/hub/vim-utilities

git clone git@github.com:vim-utilities/splits-jump.git

---

If not using a plugin manager, then this plugin may be installed via make install command...

cd ~/git/hub/vim-utilities/splits-jump

make install

---

To update in the future use make upgrade command...

cd ~/git/hub/vim-utilities/splits-jump

make upgrade

---

After installation, plugin documentation may be accessed via Vim's :help command, eg...

:help splits-jump

---

Usage

All split actions are relative to current/active split, and intended to be used within Normal mode...

• Ctrlh Jump towards left split

• Ctrlj Jump towards lower split

• Ctrlk Jump towards upper split

• Ctrll Jump towards right split

---

Notes

This repository may not be feature complete and/or fully functional, Pull Requests that add features or fix bugs are certainly welcomed.

---

Contributing

Options for contributing to splits-jump and vim-utilities

---

Forking

Start making a Fork of this repository to an account that you have write permissions for.

• Add remote for fork URL. The URL syntax is git@github.com:<NAME>/<REPO>.git...

cd ~/git/hub/vim-utilities/splits-jump

git remote add fork git@github.com:<NAME>/splits-jump.git

• Commit your changes and push to your fork, eg. to fix an issue...

cd ~/git/hub/vim-utilities/splits-jump


git commit -F- <<'EOF'
:bug: Fixes #42 Issue


**Edits**


- `<SCRIPT-NAME>` script, fixes some bug reported in issue
EOF


git push fork main

Note, the -u option may be used to set fork as the default remote, eg. git push -u fork main however, this will also default the fork remote for pulling from too! Meaning that pulling updates from origin must be done explicitly, eg. git pull origin main

• Then on GitHub submit a Pull Request through the Web-UI, the URL syntax is https://github.com/<NAME>/<REPO>/pull/new/<BRANCH>

Note; to decrease the chances of your Pull Request needing modifications before being accepted, please check the dot-github repository for detailed contributing guidelines.

---

Sponsor

Thanks for even considering it!

With you may sponsor vim-utilities on a repeating basis.

Regardless of if you're able to financially support projects such as splits-jump that vim-utilities maintains, please consider sharing projects that are useful with others, because one of the goals of maintaining Open Source repositories is to provide value to the community.

---

Attribution

• GitHub -- github-utilities/make-readme

• StackOverflow -- How to get current relative directory of your Makefile

• StackOverflow -- How to remove the last trailing backslash in GNU Makefile

• StackOverflow -- Makefile execute another target

• YouTube -- nixcasts -- A look through my vimrc

---

License

Vim plugin for jumping between splits swiftly
Copyright (C) 2020 S0AndS0

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published
by the Free Software Foundation, version 3 of the License.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License
along with this program.  If not, see <https://www.gnu.org/licenses/>.

For further details review full length version of AGPL-3.0 License.