Add beginner-friendly instructions for running examples in README.md#85
Open
ragefye wants to merge 1 commit into
Open
Add beginner-friendly instructions for running examples in README.md#85ragefye wants to merge 1 commit into
ragefye wants to merge 1 commit into
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Pull Request type:
• Bugfix
• Feature
• Code style update (formatting, renaming)
• Refactoring (no functional changes, no API changes)
• Build-related changes
• Documentation content changes
• Other (please describe):
What is the current behavior?
New users need to manually figure out how to run Rust examples in the repo. The README lacks beginner-friendly guidance.
What is the new behavior?
• Added a “Running Examples for Beginners” section under Quick Start.
• Provides step-by-step instructions to install Rust, clone the repo, navigate folders, and run a simple example (hello_world.rs).
• Includes guidance for exploring other examples in the examples/ folder.
Does this introduce a breaking change?
• No
Other information
This change only affects documentation. No code is modified. It helps onboard new contributors and users more easily.