Skip to content

Docs: INSTALL.md suggestions #3607

Description

@jfdev001

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

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions