search

rupa / z

z - jump around
Do What The F*ck You Want To Public License
16.39k stars 1.17k forks source link

better install instructions #229

Open swyxio opened 6 years ago

swyxio commented 6 years ago

brew install z didnt work for me

so here is @wesbos' instructions https://www.youtube.com/watch?v=qbNn5zJLZU0

these should prob be included in the readme..

mgiugliano commented 5 years ago

For its (automated) installation, I have been using something like:

git clone https://github.com/rupa/z/ ~/tmp/z chmod +x ~/tmp/z/z.sh mv ~/tmp/z/z.sh /usr/local/bin/ mv ~/tmp/z/z.1 /usr/local/share/man/man1 rm -rf ~/tmp/z

mitchellporter commented 5 years ago

@sw-yx After installing with homebrew try running brew info z and read the Caveats section. After updating my .zshrc file it's working perfectly.

swyxio commented 5 years ago

cool i mean i have it running right now so its not a problem but if the plain fact is that brew install z doesnt work out of the box it should probably have better docs..

mitchellporter commented 5 years ago

but if the plain fact is that brew install z doesnt work out of the box it should probably have better docs..

Yeah that's a good point I agree.

mlncn commented 5 years ago

Just putting brew install z somewhere on the project homepage would also be a nice start!

borlafu commented 5 years ago

The Caveats after brew install z tell you what to do :)

==> Downloading https://github.com/rupa/z/archive/v1.9.tar.gz
==> Downloading from https://codeload.github.com/rupa/z/tar.gz/v1.9
######################################################################## 100.0%
==> Caveats
For Bash or Zsh, put something like this in your $HOME/.bashrc or $HOME/.zshrc:
  . /usr/local/etc/profile.d/z.sh
==> Summary
🍺  /usr/local/Cellar/z/1.9: 5 files, 20.7KB, built in 3 seconds
tekumara commented 5 years ago

I'm using the following with macOS and zsh to install z idempotently:

brew install z
grep -q z\.sh ~/.zshrc || echo ". /usr/local/etc/profile.d/z.sh" >> ~/.zshrc

+1 for adding instructions to the README

prasad-shirodkar commented 10 months ago

For its (automated) installation, I have been using something like:

git clone https://github.com/rupa/z/ ~/tmp/z
chmod +x ~/tmp/z/z.sh
mv ~/tmp/z/z.sh /usr/local/bin/
mv ~/tmp/z/z.1 /usr/local/share/man/man1
rm -rf ~/tmp/z

I had to do the following for man z command to work correctly on linux (I am on debian):

git clone https://github.com/rupa/z/ ~/tmp/z
chmod +x ~/tmp/z/z.sh
sudo mv ~/tmp/z/z.sh /usr/local/bin/
sudo mkdir -p /usr/local/share/man/man1    # create the man1 directory if it does not exist
sudo mv ~/tmp/z/z.1 /usr/local/share/man/man1/    # move z.1 file under the man1 directory
rm -rf ~/tmp/z