docs: add desktop development commands to README.md #527
Conversation
WalkthroughThis update adds a new section to the README that details planned support for desktop application development using the Tauri framework. The section outlines prerequisites such as Node.js (v16 or higher), npm (v8 or higher), and the Tauri framework. It also describes the anticipated workflow with npm commands for running and building desktop applications. No changes were made to exported or public entities. Changes
Sequence Diagram(s)sequenceDiagram
participant Dev as Developer
participant CLI as Command Line
participant Tauri as Tauri Framework
Dev->>CLI: Run npm command (dev/build)
CLI->>Tauri: Initiate desktop application process
Tauri-->>CLI: Return application status
CLI-->>Dev: Display application status/info
Poem
Tip ⚡🧪 Multi-step agentic review comment chat (experimental)
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
✅ Deploy Preview for circuitverse ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (3)
README.md (3)
35-36: Improve Clarity in Tauri Reference.In the sentence "This section provides preliminary information for future desktop application development using tauri framework," consider capitalizing "Tauri" and adding the definite article for clarity. For example, "using the Tauri framework" makes the reference clearer and aligns with common naming conventions.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~35-~35: You might be missing the article “the” here.
Context: ...e desktop application development using tauri framework. ### Prerequisites (Planned)...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
42-44: Well-Structured Future Implementation Guidance.The "### Future Implementation" section effectively outlines the anticipated workflow. Including the npm commands for both development (
npm run tauri dev) and production build (npm run tauri build) provides clear guidance for users. If desired, additional context on environment configurations or troubleshooting tips could further enhance this section, though it is optional for this PR.
35-35: Static Analysis Note: Missing Article.A static analysis hint suggested a potential missing article in the phrase "using tauri framework." Applying the earlier suggestion to change it to "using the Tauri framework" will address this minor grammatical improvement.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~35-~35: You might be missing the article “the” here.
Context: ...e desktop application development using tauri framework. ### Prerequisites (Planned)...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
README.md
[uncategorized] ~35-~35: You might be missing the article “the” here.
Context: ...e desktop application development using tauri framework. ### Prerequisites (Planned)...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
🔇 Additional comments (3)
README.md (3)
33-34: Clear and Informative Section Addition.The "Desktop Application Development" section is clearly labeled and directly addresses the PR objectives by outlining the prerequisites and anticipated workflow for desktop application development.
37-41: Detailed Prerequisites Listing.The prerequisites under "### Prerequisites (Planned)" are clearly listed, specifying Node.js v16 or higher, npm v8 or higher, and the desktop application framework (Tauri). This directly supports developers in preparing their environment for future implementations.
45-51: Clear Code Examples for Development and Build Commands.The bash code block demonstrating the usage of the commands is well-formatted and serves as a practical reference for developers. It aligns with the PR's goal of enhancing desktop development documentation by showing exactly how to run and build the application.
|
CC: @niladrix719 |
| @@ -30,6 +30,26 @@ To set up the project on your local machine, follow these steps: | |||
| npm run dev | |||
| ``` | |||
|
|
|||
| ## Desktop Application Development | |||
| > **Note**: Desktop application support is currently a planned feature (see To-Dos item #4). | |||
There was a problem hiding this comment.
no need to add note for now
| ### Prerequisites (Planned) | ||
| - Node.js v16 or higher | ||
| - npm v8 or higher | ||
| - Desktop application framework (Tauri) |
There was a problem hiding this comment.
Tauri only have prerequisites rust and cargo, move node and npm to prerequisites to web app
| ### Future Implementation | ||
| Once desktop application support is added, the following workflow is anticipated: |
|
This documentation seems decent for the Landing page, once the reprimandations are sanctioned. |
Fixes #509
Describe the changes you have made in this PR -
Added prerequisites and commands for desktop application development in the README.md:
npm run tauri devcommand for developmentnpm run tauri buildcommand for buildingSummary by CodeRabbit