-
Notifications
You must be signed in to change notification settings - Fork 4
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
base: main
Are you sure you want to change the base?
add minor windows install notes to README.rst #6
Conversation
@nicholasmhughes sorry for the markdown use of a table messing up the pre-commit rstcheck. Hope we are passed that now. |
I hope that is it. @nicholasmhughes thanks for you patience. |
# 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/ | ||
|
There was a problem hiding this comment.
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?
# 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/ | |
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. |
No description provided.