Skip to content

docs: add setup troubleshooting for windows users #35#101

Open
aditii23 wants to merge 1 commit intosugarlabs:mainfrom
aditii23:docs-setup-guide-35
Open

docs: add setup troubleshooting for windows users #35#101
aditii23 wants to merge 1 commit intosugarlabs:mainfrom
aditii23:docs-setup-guide-35

Conversation

@aditii23
Copy link
Copy Markdown

I have updated the README.md to include a dedicated "Cross-Platform Setup & Troubleshooting" section.

Key Additions:
Error Explanation: Clarified why dbus and sugar-launch fail on non-Sugar environments.
Platform Matrix: Added a table comparing capabilities across Native Windows, WSL2, and Linux.
Alternative Testing Workflow: Documented how to verify code changes using python -m py_compile and individual module testing when the full Sugar Shell is unavailable.

Why this is important?
This documentation improvement reduces friction for GSoC aspirants and contributors who may not have a native Linux/Sugar setup but want to contribute to the GenAI, TTS, or Translation logic of the activity.

Changes Made
Updated README.md with troubleshooting steps and platform-specific guidance.mn

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant