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.

Sign up for GitHub

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

Jump to bottom

add minor windows install notes to README.rst #6

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

add minor windows install notes to README.rst #6

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
a2216be
Update README.rst
TheBigBear Jul 26, 2022
7b97fa9
Update README.rst
TheBigBear Jul 26, 2022
7a6f63a
Update README.rst
TheBigBear Jul 26, 2022
14e91ea
Update README.rst
TheBigBear Jul 27, 2022
8064384
Update README.rst
TheBigBear Jul 28, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 11 additions & 4 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,11 +74,19 @@ Install from source
git clone [email protected]/eitrtechnologies/idemenv.git
cd idemenv

# Setup venv
# 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/

Comment on lines +77 to +89
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/

Usage
=====

Expand Down Expand Up @@ -172,9 +180,8 @@ Basic idem binary setup:

# Kick the tires!

$ idem exec test.version
local:
3004
$ idem exec test.ping
True


Common Issues
Expand Down