Skip to content

[Feature Request]:Improve Windows-specific guidance in installation guide #497

Description

@wareeshaali2003

Improve Windows-specific guidance in installation guide
Yes. The current installation guide is mostly platform-agnostic, which can cause confusion for Windows users. As a first-time contributor using Windows, it was unclear which terminal to use, which Python command (python vs. py) is recommended, and how to avoid common issues like CRLF line endings.

Describe the solution (or solutions) you'd like

Add a short Windows-specific section to the installation guide that:

  • Recommends a preferred terminal (e.g., Git Bash)
  • Clarifies which Python command to use on Windows
  • Mentions common Windows pitfalls such as CRLF line endings
    Suggests suitable editors like VS Code with appropriate settings

Describe alternatives you've considered and rejected

I considered relying on external troubleshooting pages, but having these Windows-specific notes directly in the installation guide would be more helpful for first-time contributors.

This would make the setup process easier for new Windows contributors.

Additional context

This suggestion is based on my experience installing Oppia as a beginner on Windows.

Activity

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions