Skip to content

Commit 9be2d44

Browse files
committed
Update clone instructions
1 parent c2bab2e commit 9be2d44

File tree

2 files changed

+33
-28
lines changed

2 files changed

+33
-28
lines changed

00-quick-start/README.md

Lines changed: 30 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -36,9 +36,9 @@ If you see "You don't have access to GitHub Copilot," you'll need to use the fre
3636

3737
> ⏱️ **Time estimate**: Installation takes 2-5 minutes. Authentication adds another 1-2 minutes.
3838
39-
### Recommended: GitHub Codespaces (Zero Setup)
39+
### GitHub Codespaces (Zero Setup)
4040

41-
If you don't want to install any of the prerequisites, you can use GitHub Codespaces, which has the GitHub Copilot CLI ready to go (you'll need to sign in), pre-installs Python 3.13, pytest, and the GitHub CLI.
41+
If you don't want to install any of the prerequisites you can use GitHub Codespaces, which has the GitHub Copilot CLI ready to go (you'll need to sign in), and pre-installs Python and pytest.
4242

4343
1. [Fork this repository](https://github.com/github/copilot-cli-for-beginners/fork) to your GitHub account
4444
2. Select **Code** > **Codespaces** > **Create codespace on main**
@@ -47,40 +47,45 @@ If you don't want to install any of the prerequisites, you can use GitHub Codesp
4747

4848
> 💡 **Verify in Codespace**: Run `cd samples/book-app-project && python book_app.py help` to confirm Python and the sample app are working.
4949
50-
### Alternative: Local Installation
50+
### Local Installation
5151

52-
> 💡 **Not sure which to pick?** Use `npm` if you have Node.js installed. Otherwise, choose the option that matches your system.
52+
Follow these steps if you'd like to run Copilot CLI on your local machine with the course samples.
5353

54-
> 💡 **Python required for demos**: The course uses a Python sample app. If you're working locally, install [Python 3.10+](https://www.python.org/downloads/) before starting the demos.
54+
1. Clone the repo to get the course samples on your machine:
5555

56-
> **Note:** While the primary examples shown throughout the course use Python (`samples/book-app-project`), JavaScript (`samples/book-app-project-js`) and C# (`samples/book-app-project-cs`) versions are also available if you prefer to work with those languages. Each sample has a README with instructions for running the app in that language.
56+
```bash
57+
git clone https://github.com/github/copilot-cli-for-beginners
58+
cd copilot-cli-for-beginners
59+
```
5760

58-
Choose the method that works for your system:
61+
2. Install Copilot CLI using one of the following options.
5962

60-
### All Platforms (npm)
63+
> 💡 **Not sure which to pick?** Use `npm` if you have Node.js installed. Otherwise, choose the option that matches your system.
6164

62-
```bash
63-
# If you have Node.js installed, this is a quick way to get the CLI
64-
npm install -g @github/copilot
65-
```
65+
### All Platforms (npm)
6666

67-
### macOS/Linux (Homebrew)
67+
```bash
68+
# If you have Node.js installed, this is a quick way to get the CLI
69+
npm install -g @github/copilot
70+
```
6871

69-
```bash
70-
brew install copilot-cli
71-
```
72+
### macOS/Linux (Homebrew)
7273

73-
### Windows (WinGet)
74+
```bash
75+
brew install copilot-cli
76+
```
7477

75-
```bash
76-
winget install GitHub.Copilot
77-
```
78+
### Windows (WinGet)
7879

79-
### macOS/Linux (Install Script)
80+
```bash
81+
winget install GitHub.Copilot
82+
```
8083

81-
```bash
82-
curl -fsSL https://gh.io/copilot-install | bash
83-
```
84+
### macOS/Linux (Install Script)
85+
86+
```bash
87+
curl -fsSL https://gh.io/copilot-install | bash
88+
```
8489

8590
---
8691

@@ -153,7 +158,7 @@ After you receive a response, you can exit the CLI:
153158

154159
The course provides a sample app that you'll explore and improve throughout the course using the CLI *(You can see the code for this in /samples/book-app-project)*. Check that the *Python book collection terminal app* works before you get started. Run `python` or `python3` depending on your system.
155160
156-
> **Note:** While the primary examples shown throughout the course use Python (`samples/book-app-project`), JavaScript (`samples/book-app-project-js`) and C# (`samples/book-app-project-cs`) versions are also available if you prefer to work with those languages. Each sample has a README with instructions for running the app in that language.
161+
> **Note:** The primary examples shown throughout the course use Python (`samples/book-app-project`) so you'll need to have [Python 3.10+](https://www.python.org/downloads/) available on your local machine if you chose that option (the Codespace already has it installed). JavaScript (`samples/book-app-project-js`) and C# (`samples/book-app-project-cs`) versions are also available if you prefer to work with those languages. Each sample has a README with instructions for running the app in that language.
157162

158163
```bash
159164
cd samples/book-app-project

01-setup-and-first-steps/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ Now let's see why developers are calling this "having a senior engineer on speed
6262
6363
### Demo 1: Code Review in Seconds
6464

65-
The course includes sample files with intentional code quality issues. Let's review one:
65+
The course includes sample files with intentional code quality issues. If you're working on your local machine and haven't already cloned the repo, please run the `git clone` command below, navigate to the `copilot-cli-for-beginners` folder, and then run the `copilot` command.
6666

6767
```bash
6868
# Clone the course repository if you're working locally and haven't already
@@ -73,13 +73,13 @@ cd copilot-cli-for-beginners
7373
copilot
7474
```
7575

76-
Once inside the interactive session:
76+
Once inside the interactive Copilot CLI session, run the following:
7777

7878
```
7979
> Review @samples/book-app-project/book_app.py for code quality issues and suggest improvements
8080
```
8181

82-
> 💡 **What's the `@`?** The `@` symbol tells Copilot CLI to read a file. You'll learn all about this in Chapter 02. For now, just copy the command exactly as shown.
82+
> 💡 **What's the `@` symbol used for?** The `@` symbol tells Copilot CLI to read a file. You'll learn all about this in Chapter 02. For now, just copy the command exactly as shown.
8383
8484
---
8585

0 commit comments

Comments
 (0)