search

wting / autojump

A cd command that learns - easily navigate directories from the command line
Other
16.15k stars 705 forks source link

README - Tell users to read the post-install message #323

Open britishdan opened 9 years ago

britishdan commented 9 years ago

For dumb users like me who didn't read the post install message and couldn't figure out why it's not working. Thanks!

TomasTomecek commented 9 years ago

How will this work in distriutions? And especially in packaging systems where there is no support for displaying messages when your package is successfully installed. I think that README should contain instructions for installation (the post install message you are talking about).

britishdan commented 9 years ago

Good question. What do you do in distros that do not display the post message? How do users know to add the line to their bash_profile?

Fyi I'm on Mac and I did see the message (I didn't see it to begin with because I didn't think to look)

simonweil commented 9 years ago

Using brew on Mac you get the post install message. Is it good enough?

TomasTomecek commented 9 years ago

In Fedora, user doesn't need to do anything, because bash (and I'm not sure if zsh too) is sourcing /etc/profile and part of that script is this

for i in /etc/profile.d/*.sh ; do
  . "$i" >/dev/null
done

Since autojump is installed globally it lives in /etc/profile.d/autojump.sh and therefore it gets sourced as soon as you spawn new shell.

So you get working autojump out of the box.

I'm not sure about other distros/shells.

britishdan commented 9 years ago

Being a dumb user and all, I didn't think to look for a post message. Brew finished the install and I closed the terminal. A few days later I see that it's not working. So I go to the README, which didn't help at all. In the end I uninstalled and installed again. I then saw the message.

I think that to help users in the future, it would be good to have a "not working?" section with some helpful hints. The content of the post message could be one such hint.

blueyed commented 9 years ago

Yes, this would need a generic form / all variants of https://github.com/joelthelion/autojump/blob/master/install.py#L139-L161 in the README.