Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Windows instructions in "Validating Manifest" #502

Open
CookiePLMonster opened this issue Sep 19, 2024 · 1 comment
Open

Windows instructions in "Validating Manifest" #502

CookiePLMonster opened this issue Sep 19, 2024 · 1 comment
Assignees

Comments

@CookiePLMonster
Copy link
Contributor

Currently, Validating Manifest instructions are only for POSIX systems, for Windows the steps are a bit different depending on whether you use cmd.exe or PowerShell.

I can PR those instructions in since I had to figure it out yesterday, but how would that be best structured? The two ideas I had were:

  1. Have the instructions copied over twice, so each platform's instructions are "full":

    Validating Manifest

    POSIX systems

    You can check your manifest file for validity before submitting it to this repository. To do so, set up a virtual Python environment with the required dependencies:

    python3 -m venv venv
    source venv/bin/activate
    pip install -r tools/requirements.txt

    [and so on...]

    Windows (cmd)

    You can check your manifest file for validity before submitting it to this repository. To do so, set up a virtual Python environment with the required dependencies:

    python -m venv venv
    venv\Scripts\activate.bat
    python -m pip install -r tools\requirements.txt

    [and so on...]

    Windows (PowerShell)

    You can check your manifest file for validity before submitting it to this repository. To do so, set up a virtual Python environment with the required dependencies:

    python -m venv venv
    .\venv\Scripts\Activate.ps1
    python -m pip install -r tools\requirements.txt

    [and so on...]

  2. Have full instructions only in the first sub-section, and then go for shorthands in Windows sections:

    Validating Manifest

    POSIX systems

    You can check your manifest file for validity before submitting it to this repository. To do so, set up a virtual Python environment with the required dependencies:

    python3 -m venv venv
    source venv/bin/activate
    pip install -r tools/requirements.txt

    [and so on...]

    Windows (cmd)

    Set up a virtual Python environment:

    python -m venv venv
    venv\Scripts\activate.bat
    python -m pip install -r tools\requirements.txt

    [and so on...]

    Windows (PowerShell)

    Set up a virtual Python environment:

    python -m venv venv
    .\venv\Scripts\Activate.ps1
    python -m pip install -r tools\requirements.txt

    [and so on...]

@doomwastaken
Copy link
Member

Thank you for submission, I will ask hedger for his input, since he is original author of documentation

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

No branches or pull requests

3 participants