docs: add HTTPS clone option alongside SSH in README#2181
Open
NethmikaKekuu wants to merge 2 commits into
Open
docs: add HTTPS clone option alongside SSH in README#2181NethmikaKekuu wants to merge 2 commits into
NethmikaKekuu wants to merge 2 commits into
Conversation
Added instructions for cloning the repository using HTTPS.
Removed duplicate installation instructions for markitdown.
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
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 the HTTPS clone URL as an alternative to the existing SSH clone command in the installation instructions.
Motivation
The README's "Installation" section only shows the SSH clone command (
git@github.com:microsoft/markitdown.git). This works fine for contributors who already have an SSH key configured with GitHub, but new users without SSH keys set up hit a confusing error:Since this is a public repo, HTTPS cloning works with no setup at all. Adding it alongside SSH makes the "Installation" section easier to follow for first-time users, while keeping the SSH option for those who prefer it.
Change
Checklist