xen0n / autojump-rs

A fast drop-in replacement of autojump written in Rust
https://github.com/xen0n/autojump-rs/releases
GNU General Public License v3.0
242 stars 14 forks source link

Installation instructions are incomplete #9

Open TomasTomecek opened 6 years ago

TomasTomecek commented 6 years ago

Thanks for porting and maintaining autojump! I had the same idea and now I'm glad that I don't have to do it myself.

It seems that not all the installation instructions are present in this repo, namely function definitions, completion setup and shell integration. Are you planning to provide those?

xen0n commented 6 years ago

Hi,

The first steps are omitted because I thought it'd be more convenient to simply install the Python version first, then overriding it by $PATH manipulation or other means. So the setup you mentioned are the same as the original. Maybe I can make this point clearer in the README...

TomasTomecek commented 6 years ago

I think that would be really helpful.

arashm commented 5 years ago

I wonder why this app should be depended to the original autojump. I removed python version and installed this, realized that shell files doesn't exist anymore, so I had to make a simple function in my fish to make it work.

function j -d "Autojump alias" -w "autojump"
  cd (env AUTOJUMP_SOURCED=1 autojump $argv)
end

Can't those shell files be a part of the package and ask user to source them in the shell configs?

zou000 commented 4 years ago

For an easier shell integration, maybe implement something like eval $(autojump --shell), like the way golang jump did: https://github.com/gsamokovarov/jump/blob/master/README.md