Add comprehensive installation guide to README

[thatraghavarora]

Summary by CodeRabbit

• Documentation
  • Added a comprehensive Installation Guide to the README covering prerequisites, cloning, frontend and Python backend setup, environment configuration, Tauri CLI usage, build/run commands, usage notes, troubleshooting, and links to alternate documentation to improve onboarding and setup reliability.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[github-actions]

⚠️ No issue was linked in the PR description.
Please make sure to link an issue (e.g., 'Fixes #issue_number')

[coderabbitai]

Walkthrough

Adds a comprehensive installation and setup guide to README.md covering prerequisites, cloning, frontend and Python backend dependency installation, environment configuration, Tauri CLI setup, build/run commands, usage notes, troubleshooting, and an alternative documentation reference. No functional code changes.

Changes

Cohort / File(s)	Summary
Documentation Update README.md	Added a detailed Installation Guide: prerequisites, step-by-step setup (clone, frontend & Python backend dependencies), environment variable instructions, Tauri CLI setup, build and run commands, usage notes, troubleshooting, alternative docs link, and closing notes.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

• Single-file documentation addition with no code or API changes
• Review focus: clarity, accuracy, and formatting in README

Possibly related PRs

• DOC: Remove setup instructions from docs website and create unified s… #440 — Consolidates and updates project setup documentation; touches the same README/setup docs and mkdocs navigation.

Poem

🐰 I hopped through lines of setup cheer,
Wrote steps so builders need not fear,
From clone to build, each command in sight,
A README bloom in soft moonlight,
Install, run, and code — delight! 🥕✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title 'Add comprehensive installation guide to README' directly and accurately describes the main change: adding an installation guide to the README.md file.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[github-actions]

⚠️ No issue was linked in the PR description.
Please make sure to link an issue (e.g., 'Fixes #issue_number')

[coderabbitai]

Actionable comments posted: 2

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between d07d817 and f6b4dc4.

📒 Files selected for processing (1)

• README.md (1 hunks)

🧰 Additional context used

🪛 markdownlint-cli2 (0.18.1)

README.md

70-70: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4

(MD001, heading-increment)

---

73-73: Bare URL used

(MD034, no-bare-urls)

---

81-81: Bare URL used

(MD034, no-bare-urls)

---

118-118: Bare URL used

(MD034, no-bare-urls)

---

139-139: Bare URL used

(MD034, no-bare-urls)

---

140-140: Bare URL used

(MD034, no-bare-urls)

---

143-143: Bare URL used

(MD034, no-bare-urls)

🔇 Additional comments (1)

README.md (1)

64-147: Comprehensive installation guide addition—well done.

The installation guide section is well-structured, detailed, and platform-aware. It covers prerequisites, step-by-step setup, troubleshooting, and alternative resources effectively. The inclusion of system-specific dependency information (Ubuntu, Fedora, macOS, Windows) is especially helpful for reducing friction during initial setup.

[github-actions]

⚠️ No issue was linked in the PR description.
Please make sure to link an issue (e.g., 'Fixes #issue_number')

[thatraghavarora]

Add comprehensive installation guide to README

[github-actions]

⚠️ No issue was linked in the PR description.
Please make sure to link an issue (e.g., 'Fixes #issue_number')

[github-actions]

⚠️ No issue was linked in the PR description.
Please make sure to link an issue (e.g., 'Fixes #issue_number')

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

README.md (1)

121-121: Bare URL in code block comment — linter flag (likely false positive).

Static analysis flags a bare URL on line 121 (MD034) in the cargo command comment. Like line 84, this is within a code block and the URL is a reference the comment provides. If strict linting is required, you could move the reference to prose above the code block:

- 4. *Install Tauri CLI*
+ 4. *Install Tauri CLI*
+    For detailed setup, see [Tauri's setup guide](https://tauri.app/v1/guides/getting-started/prerequisites).
     
-    cargo install tauri-cli   # Or follow Tauri's setup: https://tauri.app/v1/guides/getting-started/prerequisites
+    cargo install tauri-cli

However, the current approach is practical and clear for users.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f6b4dc4 and 817e0ee.

📒 Files selected for processing (1)

• README.md (1 hunks)

🧰 Additional context used

🪛 markdownlint-cli2 (0.18.1)

README.md

84-84: Bare URL used

(MD034, no-bare-urls)

---

121-121: Bare URL used

(MD034, no-bare-urls)

🔇 Additional comments (2)

README.md (2)

84-85: Bare URL in code block — linter flag (likely false positive).

Static analysis flags a bare URL on line 84 (MD034), but this is part of the functional git clone command. Converting it to markdown link syntax would break the command's usability. This appears to be a false positive, as the MD034 rule is designed for prose text, not executable code snippets.

If strict linting compliance is required, you could extract the repository URL to prose above the code block, though this would reduce clarity for users copying the command.

---

64-151: Comprehensive, well-structured installation guide — excellent addition.

The installation guide is clear, comprehensive, and user-friendly. The heading hierarchy is correct, prerequisites are detailed, step-by-step instructions cover frontend/backend/Tauri setup, system dependencies are platform-specific (Ubuntu/Debian, Fedora, macOS, Windows), and troubleshooting is practical. The guide properly references external resources and closing notes are helpful. All URLs in prose text are correctly wrapped in markdown link syntax.