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

Update README.md #804

Merged
merged 4 commits into from
Oct 3, 2023
Merged

Update README.md #804

merged 4 commits into from
Oct 3, 2023

Conversation

AlexanderRichert-NOAA
Copy link
Collaborator

Summary

This PR reorganizes and shortens the spack-stack README. My main goal is to make it quicker and easier to navigate, especially for new users, and in particular to make the Getting Started documentation easy to find. I've tried to consolidate redundant and related information along with fixing a few typos etc. The main subtraction is that I took out the text about the create env and setup-meta-modules commands since those are on the first page of the documentation (I figure a user at that level of interest in spack-stack is likely to want to read more of the documentation anyway).

Issue(s) addressed

Addresses #746

Checklist

  • This PR addresses one issue/problem/enhancement, or has a very good reason for not doing so.
  • These changes have been tested on the affected systems and applications.
  • All dependency PRs/issues have been resolved and this PR can be merged.

README.md Outdated Show resolved Hide resolved
Copy link
Collaborator

@srherbener srherbener left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for this update! I like the trimmed down version for the main README.md page. I think it helps get the main points across more effectively to someone new.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Copy link
Collaborator

@srherbener srherbener left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for adding in the link to the "creating environments" doc page.

Co-authored-by: Dom Heinzeller <dom.heinzeller@icloud.com>
Copy link
Collaborator

@climbfuji climbfuji left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks very much, sorry for being so picky.

@climbfuji climbfuji merged commit 9dd0605 into develop Oct 3, 2023
5 checks passed
@climbfuji climbfuji deleted the AlexanderRichert-NOAA-patch-1 branch October 3, 2023 18:05
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

Successfully merging this pull request may close these issues.

3 participants