This repository was archived by the owner on Jul 21, 2025. It is now read-only.
Add Getting Started section to README #64
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Adds Getting Started section between About and Contributions - Links to existing docs/RunApplication.md for detailed instructions - Surgical change with no formatting modifications to existing content
3 tasks
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Adds a Getting Started section to the README that directs new users to the existing documentation.
Changes Made
docs/RunApplication.mdfor detailed setup instructionsWhy This Change
docs/RunApplication.mdbut aren't referenced upfront in the READMETesting
docs/RunApplication.mdworks correctlyType of Change
Related Issues
Fixes part of #66 - specifically addresses Problem 1 (missing Getting Started section)