Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Readme - Add description & installation instructions #6

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Readme - Add description & installation instructions #6

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 29 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,17 +7,44 @@
</div>
<br>

# jump

A port of [Jeroen Janssens' "jump" utility] [1] to the fish shell (and [Oh My Fish!] [omf-link]).

## Description

Easily jump around the file system by manually adding marks.

Marks are stored as symbolic links in the directory $MARKPATH (default $HOME/.marks)


## Installation

With [Oh-My-Fish](https://www.github.com/oh-my-fish/oh-my-fish):

omf install jump

Without Oh-My-Fish:

TODO

## Usage

jump FOO: jump to a mark named FOO
mark FOO: create a mark named FOO
unmark FOO: delete a mark
marks: lists all marks


## Configuration

If you have a custom mark folder, you can add the following to your `~/.config/fish/before.init.fish`.

```
set -gx MARKPATH YOUR_CUSTOM_FOLDER_PATH_HERE

```
## Credits

This is a port of [Jeroen Janssens' "jump" utility](http://jeroenjanssens.com/2013/08/16/quickly-navigate-your-filesystem-from-the-command-line.html) [1] to the fish shell (and [Oh My Fish!](https://www.github.com/oh-my-fish/oh-my-fish)).

# License

Expand All @@ -27,7 +54,5 @@ set -gx MARKPATH YOUR_CUSTOM_FOLDER_PATH_HERE
[mit]: http://opensource.org/licenses/MIT
[author]: http://github.com/bpinto
[contributors]: https://github.com/oh-my-fish/plugin-rbenv/graphs/contributors
[omf-link]: https://www.github.com/oh-my-fish/oh-my-fish

[license-badge]: https://img.shields.io/badge/license-MIT-007EC7.svg?style=flat-square
[1]: http://jeroenjanssens.com/2013/08/16/quickly-navigate-your-filesystem-from-the-command-line.html