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

Restructure installation documentation #4981

Open
RudolfWeeber opened this issue Aug 14, 2024 · 0 comments
Open

Restructure installation documentation #4981

RudolfWeeber opened this issue Aug 14, 2024 · 0 comments

Comments

@RudolfWeeber
Copy link
Contributor

The high level of detail, eventhough, necessary, might make the installation instrucitons in the user guid a bit inaccessible.

We can probably improve that by restructuring a bit:
Mainly, we should aim for a better separation between the basic (necessary) steps on the one hand, and detailed explanations and advanced topics, on the other hand.

At the top, maybe we can add a super-short overview with links: Installing ESPResso usually involves the follwoing steps

  • installing depenencies [Ubuntu] [macOS] [other platforms] [explanation of dependnecies]
  • downloading the source code [release version] [develoment version]
  • configuring and compiling

Also put the link to the installation FAQ there.

For CUDA, mention, that user's should only bother, if they intend to use one of the GPU algorithms.

For the dependency installation seciont (particularly Ubuntu),
Make a more clear distinction what are "standard" and what is (optional) more advanced stuff such as Jupyter.

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

No branches or pull requests

1 participant