Update getting-started.md #1343
Conversation
Lines 12 - 15. More clarity on how to add PATH entry for Alire ecosystem client installed on a user's local Linux machine. PATH value was missing the required double quotes.
doc/getting-started.md
Outdated
| @@ -9,9 +9,9 @@ repository](https://github.com/alire-project/alire/releases). | |||
|
|
|||
| On Linux, `Alire` is simply provided in an archive. | |||
|
|
|||
| Once the archive is extracted you have to add `alr` in the environment `PATH`: | |||
| Once the archive is extracted you have to add `alr` in the environment `PATH`in the .bashrc file of the user's home directory: | |||
There was a problem hiding this comment.
I am not sure everyone will want to put that in .bashrc. I personally prefer to set the PATH every time I want to use Alire.
There was a problem hiding this comment.
Then I suppose it's a case of an either ... or ... depending on the user's choice.
Personally I would see no danger in having this additional path entry and a lot of convenience in retaining it.
There was a problem hiding this comment.
This could be reworded as to indicate that it's an optional possibility and not a requirement for use.
There was a problem hiding this comment.
Edited as per mosteo suggestion.
There was a problem hiding this comment.
I guess this belongs in a setup-environment.md document.
There was a problem hiding this comment.
Why not where it is right now, i.e. the "Getting Started" page ?
https://github.com/alire-project/alire/blob/master/doc/getting-started.md
There was a problem hiding this comment.
Why not where it is right now, i.e. the "Getting Started" page ?
I guess the environment is a big matrix of combinations of terminals, character sets, shells, configurations, etcetera not controlled by Alire. Especially on Linux. IMO Alire should not try to adapt to all kinds of specialized use cases internally.
To offer users a choice of adding the Alire client environment to their PATH environment either just for their current terminal session or for future sessions also.
Put PATH entries into .profile rather than .bashrc since some users may not be using the bash shell, i.e. may be using csh, zsh, fsh, etc.
Lines 12 - 15.
More clarity on how to add PATH entry for Alire ecosystem client installed on a user's local Linux machine.
PATH value was missing the double quotes that may be needed when file paths contain spaces, e.g. /home/me/ada stuff/alr/bin.