Skip to content

Improve Windows setup and beginner onboarding guide #46

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
Vinanthi07 wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Improve Windows setup and beginner onboarding guide #46

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ed27779
Improve Windows setup and beginner onboarding guide
Vinanthi07 May 2, 2026
5f5c00e
Improve Windows setup and beginner onboarding guide
Vinanthi07 May 2, 2026
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
26 changes: 26 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -369,3 +369,29 @@ For detailed terms, examples of permitted and prohibited uses, and definitions,
## For Teams: LiveReview

> Using `git-lrc` solo? Great. Building with a team? Check out **[LiveReview](https://hexmos.com/livereview)** — the full suite for team-wide AI code review, with dashboards, org-level policies, and review analytics. Everything `git-lrc` does, plus team coordination.
Test PR by Vinanthi
## ⚠️ Windows Setup Notes

- Use **PowerShell**, not Command Prompt, for installation commands.
- If `iwr` is not recognized, you are likely using CMD.

## 🖥️ Opening the Project

If `code .` does not work:

1. Open Visual Studio Code manually
2. Click File → Open Folder
3. Select the project folder

## 🔑 Gemini API Key Setup

- Go to https://aistudio.google.com/api-keys
- Create a new project (any name)
- Generate an API key
- Paste it during setup

## 🛠️ Common Issues

- `iwr not recognized` → Use PowerShell
- `code . not working` → Open folder manually
- `no diff content collected` → No staged changes