singularity
singularity copied to clipboard
Docs: INSTALL.md suggestions
In https://github.com/sylabs/singularity/blob/main/INSTALL.md, I suggest two changes:
- Instances of
$PATHinecho 'export PATH=$PATH:/usr/local/go/bin' >> ~/.bashrcandecho 'export PATH=$PATH:$(go env GOPATH)/bin' >> ~/.bashrcshould be replaced with\$PATH. This prevents the.bashrcfrom being unnecessarily cluttered with the expanded version of thePATHvariable. - There is a description for installing singularity via rpm, but no description for installing it from a debian package. I think before the https://github.com/sylabs/singularity/blob/main/INSTALL.md#clone-the-repo or https://github.com/sylabs/singularity/blob/main/INSTALL.md#clone-the-repo sections, it might make more sense to put the https://github.com/sylabs/singularity/blob/main/INSTALL.md#building--installing-from-an-rpm section as well as perhaps a section called
installing from a .deb package. In theinstalling from a .deb package, it should be sufficient to point the user to theAssetssection of https://github.com/sylabs/singularity/releases, tell them to download the package corresponding to their distro version, and then providing the standard commands (e.g.,sudo dpkg -i path-to-singularity-pkg.deb
- I don't think the escape is needed, due to the single quotes which prevent expansion.
$ echo 'export PATH=$PATH:/usr/local/go/bin'
export PATH=$PATH:/usr/local/go/bin
$ echo 'export PATH=$PATH:$(go env GOPATH)/bin'
export PATH=$PATH:$(go env GOPATH)/bin
- the description for installing from rpm in that doc is actually for building and RPM from the source tree and installing it... not using the release packages. If a section is added referring to the release .deb packages we should add one for using the release .rpm packages directly as well.
Thanks for the response! I will not be able to contribute to point (2)
the description for installing from rpm in that doc is actually for building and RPM from the source tree and installing it... not using the release packages. If a section is added referring to the release .deb packages we should add one for using the release .rpm packages directly as well.
any time soon but this issue is sufficiently simple that it might qualify to be labeled as good-first-issue and documentation for those seeking to contribute.