singularity icon indicating copy to clipboard operation
singularity copied to clipboard

Docs: INSTALL.md suggestions

Open jfdev001 opened this issue 9 months ago • 2 comments

In https://github.com/sylabs/singularity/blob/main/INSTALL.md, I suggest two changes:

  1. Instances of $PATH in echo 'export PATH=$PATH:/usr/local/go/bin' >> ~/.bashrc and echo 'export PATH=$PATH:$(go env GOPATH)/bin' >> ~/.bashrc should be replaced with \$PATH. This prevents the .bashrc from being unnecessarily cluttered with the expanded version of the PATH variable.
  2. 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 the installing from a .deb package, it should be sufficient to point the user to the Assets section 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

jfdev001 avatar Mar 16 '25 10:03 jfdev001

  1. 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
  1. 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.

dtrudg avatar Mar 17 '25 11:03 dtrudg

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.

jfdev001 avatar Mar 24 '25 13:03 jfdev001