Improve README with Quick Start guide and Graphviz installation steps#1527
Open
Aditya-Deshwal23 wants to merge 1 commit intoapache:mainfrom
Open
Improve README with Quick Start guide and Graphviz installation steps#1527Aditya-Deshwal23 wants to merge 1 commit intoapache:mainfrom
Aditya-Deshwal23 wants to merge 1 commit intoapache:mainfrom
Conversation
Contributor
|
@Aditya-Deshwal23 can you rebase the branch please? |
Aditya-Deshwal23
force-pushed
the
improve-readme-quickstart
branch
from
1f90f9a to
88e85a3
Compare
Author
@skrawcz Rebased the branch as requested. Please review again. |
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
2 participants
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
Added a Quick Start section and improved Graphviz installation instructions in the README.
Motivation
The current README is comprehensive but lacks a minimal working example for beginners.
This change helps new users quickly understand how to use Apache Hamilton with a simple example.
Changes
Impact
Improves onboarding experience for new users and reduces setup friction.