Add PyCharm instructions to README.md

SirGnip · SirGnip · commit b1276e0f24e0 · 2020-01-09T08:15:12.000-06:00
diff --git a/README.md b/README.md
@@ -5,7 +5,7 @@ A template for new Python projects
 
     # install to current environment (with current dir at top of repo) 
     pip install .     # "static" install
-    pip install -e .  # "editable" install
+    pip install -e .  # "editable" install (setup.py handles source being under `src/`)
 
     # run app from instal
     python -m gnp
@@ -39,3 +39,18 @@ A template for new Python projects
     mypy -p gnp
     mypy -p gnp.common
     mypy -m gnp.common.util
+
+
+# Running app from PyCharm
+
+## Use Default Python Interpreter from PyCharm
+- For `src/`, do "Mark Directory" and set as "Sources Root" (folder turns light blue) 
+- Right click on `src/gnp/__main__.py` and choose "Run \_\_main\_\_"
+    - This relies on the Run Configuration having "Add source roots to PYTHONPATH" set to true (the default)
+
+## Use local venv
+- Create venv
+- Install package into the venv (ex: `pip install -e .`)
+- Set venv as the project's Python interpreter in PyCharm
+- Right click on `src/gnp/__misc__.py` and choose "Run \_\_main\_\_"
+    - Note: This does NOT rely on a Sources Root folder being set or PYTHONPATH in the Run Configuration.
