Skip to content

Improve cross-platform setup documentation (Windows, WSL, Linux) #35

@VanshikaTygi

Description

@VanshikaTygi

While testing the Speak activity locally on both Windows and Ubuntu, I encountered some platform-specific setup issues that may be helpful to document for new contributors.

In particular:

  • Running python activity.py outside the Sugar desktop/runtime environment results in ModuleNotFoundError: dbus.
  • This behavior is expected since activity.py depends on the Sugar runtime and system-level dbus integration.
  • On Windows (without Sugar installed), the full activity cannot run outside the Sugar runtime.
  • Core modules such as TTS and LLM components can still be tested independently.

It may be helpful to add a short section in the README clarifying:

  1. The difference between testing core AI modules directly.
  2. Testing the full Sugar activity (via Sugar desktop or Sugar Live build).
  3. Any notes regarding Windows, WSL, or macOS environments.

This could reduce confusion for new contributors attempting to run the activity directly outside the Sugar environment.

I’d be happy to help draft a “Common Setup Issues” section if this sounds useful.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions