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

Add INSTALL.md #2583

Merged
merged 5 commits into from
Feb 8, 2024
Merged

Add INSTALL.md #2583

merged 5 commits into from
Feb 8, 2024

Conversation

mathomp4
Copy link
Member

@mathomp4 mathomp4 commented Feb 7, 2024

Description

This adds an INSTALL.md file to MAPL. It was pointed out in #2579 by @VictorEijkhout that MAPL doesn't really have any good instructions on how to install. So this is a first attempt at delineating that.

Related Issue

#2579

Motivation and Context

Better documentation is always better!

How Has This Been Tested?

N/A

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Trivial change (affects only documentation or cleanup)

Checklist:

  • I have tested this change with a run of GEOSgcm (if non-trivial)
  • I have added one of the required labels (0 diff, 0 diff trivial, 0 diff structural, non 0-diff)
  • I have updated the CHANGELOG.md accordingly following the style of Keep a Changelog

@mathomp4 mathomp4 added 📝 Documentation Improvements or additions to documentation 0 Diff Trivial The changes in this pull request are trivially zero-diff (documentation, build failure, &c.) labels Feb 7, 2024
@mathomp4 mathomp4 self-assigned this Feb 7, 2024
@mathomp4 mathomp4 requested a review from a team as a code owner February 7, 2024 15:22
INSTALL.md Outdated Show resolved Hide resolved
tclune
tclune previously approved these changes Feb 7, 2024
Copy link
Collaborator

@tclune tclune left a comment

Choose a reason for hiding this comment

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

One comment that might be worth addressing.

You also might consider having @JulesKouatchou act as a tester for the instructions.

@tclune tclune merged commit 220ccea into develop Feb 8, 2024
27 checks passed
@tclune tclune deleted the feature/mathomp4/add-install-md branch February 8, 2024 18:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
0 Diff Trivial The changes in this pull request are trivially zero-diff (documentation, build failure, &c.) 📝 Documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants