Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Installation Guide: Required Dependencies for Supported Operating Systems and Distributions #3160

Open
shakatoday opened this issue Nov 14, 2024 · 2 comments

Comments

@shakatoday
Copy link
Contributor

shakatoday commented Nov 14, 2024

The installation guide currently lacks detailed information on the dependencies required for various supported operating systems and distributions. To help users set up the project smoothly, we should add a section in docs/installation.md that outlines the dependencies for each supported OS and distro (e.g., Ubuntu, Debian, macOS, etc.). This will ensure that users have a clear understanding of the prerequisites and can avoid common setup issues.

@yifanmai
Copy link
Collaborator

Are you running into an issue with a specific distro? I believe HELM should work on Ubuntu and MacOS; Debian hasn't been tested but I don't see why it wouldn't work.

There is a known issue that HELM doesn't work on Windows; see #2907.

@shakatoday
Copy link
Contributor Author

shakatoday commented Nov 15, 2024

Oh, sorry it's for Developer setup, so it should be docs/developer_setup.md

For Ubuntu, it's quite trivial such as build-essential and unzip.
Even though they are trivial, some open-source projects include git in their setup dependencies if a distro needs it.

This issue should be a very low priority I think.

On the other hand, do you think that the setup of cuda should be mentioned in both docs/installation.md and docs/developer_setup.md?

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

No branches or pull requests

2 participants