docs: add Tauri prerequisites and dev/build commands to README

[blazethunderstorm]

Fixes #509

Describe the changes you have made in this PR -

Added Tauri prerequisites, Rust installation steps, and npm run tauri dev/build commands to README.

Screenshots of the changes (If any) -

Note: Please check Allow edits from maintainers. if you would like us to assist in the PR.

Summary by CodeRabbit

• Documentation
  • Expanded the README with prerequisites and setup instructions for desktop application development using Tauri.
  • Added detailed Rust installation steps and platform-specific dependency guidance for Windows, macOS, and Linux.
  • Included commands for running and building the desktop app, along with the output location.
  • Made minor formatting improvements.

[coderabbitai]

Walkthrough

The README.md file was updated to include comprehensive documentation for desktop application development using Tauri. This includes prerequisites, installation steps for Rust and system dependencies, and instructions for running and building the desktop application. Existing web development instructions remain unchanged, with only additions and minor formatting adjustments made.

Changes

File(s)	Change Summary
README.md	Added prerequisites and detailed instructions for desktop (Tauri) development, including platform-specific setup.

Assessment against linked issues

Objective	Addressed	Explanation
Add prerequisites for desktop application development to README (including Rust, etc.) (#509)	✅
Add commands (npm run tauri dev and npm run tauri build) for dev/build to README (#509)	✅

Assessment against linked issues: Out-of-scope changes

No out-of-scope changes were found.

---

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

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[netlify]

✅ Deploy Preview for circuitverse ready!

Name	Link
🔨 Latest commit	6daf710
🔍 Latest deploy log	https://app.netlify.com/projects/circuitverse/deploys/684440949fb4ff0008a9cafd
😎 Deploy Preview	https://deploy-preview-578--circuitverse.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.
Lighthouse	1 paths audited Performance: 48 (🟢 up 2 from production) Accessibility: 72 (no change from production) Best Practices: 92 (no change from production) SEO: 80 (no change from production) PWA: - View the detailed breakdown and full score reports

---

To edit notification comments on pull requests, go to your Netlify project configuration.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

README.md (1)

171-171: Correct spelling of jQuery.

The To Dos list should reference “jQuery” (capital “Q”) rather than “JQuery” for consistency with the library’s official branding.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f64c366 and 6daf710.

📒 Files selected for processing (1)

• README.md (3 hunks)

🔇 Additional comments (5)

README.md (5)

13-19: Prerequisites section is clear and well-structured.

The new “Prerequisites” section cleanly separates web and desktop requirements, with appropriate version calls for Node.js and npm. Heading levels and bullet formatting align with the rest of the document.

---

20-23: Desktop development prerequisites are correctly listed.

Rust and system dependencies are properly highlighted under a clear subheading.

---

24-38: Rust installation instructions are accurate.

Step-by-step guidance (rustup.rs link, environment sourcing, version checks) is comprehensive and easy to follow.

---

40-91: Platform-specific dependency instructions are comprehensive.

Windows, macOS, and major Linux distributions are all covered with explicit package lists. Formatting and code blocks are consistent.

---

113-129: Tauri development and build commands are correct.

“npm run tauri dev” and “npm run tauri build” are the standard commands, and the output path is clearly specified.

[blazethunderstorm]

@niladrix719 pls review the pr , thanks

[Arnabdaz]

Lets move the whole getting started to a new md file as its in the circuitverse main repo.

[blazethunderstorm]

@Arnabdaz alright would make the changes, thanks for your review