Skip to content

docs: improve wording, add SSH method #8

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+5 −2
Open

docs: improve wording, add SSH method #8

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -4,11 +4,14 @@ In this repository, various exercises for practicing Git and GitHub skills may b

## Prerequisites

[Install](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) Git on your device.
1. [Install](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) Git on your device.
2. Create a GitHub account.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

📖 Creating a GitHub account is also optional for the HTTPS method.

Suggested change
2. Create a GitHub account.
2. (SSH only) Create a GitHub account.

3. (optional) If you wish to use the SSH clone method, upload your SSH public key to GitHub.

## Setup

Clone this repository using [HTTPS](https://docs.github.com/en/get-started/getting-started-with-git/about-remote-repositories#cloning-with-https-urls).
Download this repository using [HTTPS](https://docs.github.com/en/get-started/getting-started-with-git/about-remote-repositories#cloning-with-https-urls).
Copy link
Contributor Author

Choose a reason for hiding this comment

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

🔡 Nitpick: The technical term is cloning.

Suggested change
Download this repository using [HTTPS](https://docs.github.com/en/get-started/getting-started-with-git/about-remote-repositories#cloning-with-https-urls).
Clone this repository using [HTTPS](https://docs.github.com/en/get-started/getting-started-with-git/about-remote-repositories#cloning-with-https-urls).

Alternatively using [SSH](https://docs.github.com/en/get-started/getting-started-with-git/about-remote-repositories#cloning-with-ssh-urls)

```bash
git clone https://github.com/flowup/git-workshop.git
Copy link
Contributor Author

Choose a reason for hiding this comment

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

📖 Documentation structure: The link is only for HTTPS. Perhaps the HTTPS method could be in a separate h3 section, so that the differences between setup via each method are clear. What do you think?