Skip to content

add minor windows install notes to README.rst#6

Open
TheBigBear wants to merge 5 commits into
eitrtechnologies:mainfrom
TheBigBear:TheBigBear-add-win-install-notes
Open

add minor windows install notes to README.rst#6
TheBigBear wants to merge 5 commits into
eitrtechnologies:mainfrom
TheBigBear:TheBigBear-add-win-install-notes

Conversation

@TheBigBear
Copy link
Copy Markdown

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
Copy Markdown
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
Copy Markdown
Author

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

Comment thread README.rst
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
Copy Markdown
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
Copy Markdown
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