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

add minor windows install notes to README.rst #6

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

TheBigBear
Copy link

No description provided.

@TheBigBear TheBigBear changed the title Update README.rst add minor windows install notes to README.rst Jul 26, 2022
@TheBigBear
Copy link
Author

@nicholasmhughes sorry for the markdown use of a table messing up the pre-commit rstcheck. Hope we are passed that now.

@TheBigBear
Copy link
Author

I hope that is it. @nicholasmhughes thanks for you patience.

Comment on lines +77 to +89
# Setup venv (linux & macos)
python3 -m venv .venv --prompt idemenv
source .venv/bin/activate
pip install -e .

# Setup venv (windows)
python3 -m venv .venv --prompt idemenv
. .venv\Scripts\activate
pip install -e .

# Note: Microsoft Visual C++ 14.0 or greater is required. Get it with "Microsoft C++ Build Tools":
# https://visualstudio.microsoft.com/visual-cpp-build-tools/

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This section has been a little problematic with rstcheck. How about something like the following?

Suggested change
# Setup venv (linux & macos)
python3 -m venv .venv --prompt idemenv
source .venv/bin/activate
pip install -e .
# Setup venv (windows)
python3 -m venv .venv --prompt idemenv
. .venv\Scripts\activate
pip install -e .
# Note: Microsoft Visual C++ 14.0 or greater is required. Get it with "Microsoft C++ Build Tools":
# https://visualstudio.microsoft.com/visual-cpp-build-tools/
**Linux & MacOS:**
.. code-block:: bash
# Setup venv
python3 -m venv .venv --prompt idemenv
source .venv/bin/activate
pip install -e .
**Windows:**
.. code-block::
# Setup venv
python3 -m venv .venv --prompt idemenv
. .venv\Scripts\activate
pip install -e .
.. note::
Microsoft Visual C++ 14.0 or greater is required. Get it with "Microsoft C++ Build Tools":
https://visualstudio.microsoft.com/visual-cpp-build-tools/

@TheBigBear
Copy link
Author

absolutely, whatever works. I am so sorry, I do not have pre-commit, so I could not check it myself. same of course for the same entry on your saltenv git repo.

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.

2 participants