dev: Updates to gitignore and installation instructions (#846)

* Add environment section with `venv/` into gitignore file * Quoted `".[dev]"` in installation instructions to keep compatibility with zsh shell.
pyta-uoft · Sep 24, 2022 · a7ec6ae · a7ec6ae
1 parent e3d8e71
commit a7ec6ae
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 1 deletion.
diff --git a/.gitignore b/.gitignore
@@ -26,3 +26,6 @@ tests/test_type_inference/png*
 
 # Sphinx documentation build files
 docs/_build
+
+# Environments
+venv/
diff --git a/README.md b/README.md
@@ -33,7 +33,7 @@ If you're interested in using PyTA, you can install it using `pip` (or `pip3`, o
 If you're developing PyTA:
 
 1. First, clone this repository.
-2. Open a terminal in this repo, and run `pip install -e .[dev]` to install the dependencies.
+2. Open a terminal in this repo, and run `pip install -e ".[dev]"` to install the dependencies.
 3. Then run `pre-commit install` to install the pre-commit hooks (for automatically formatting and checking your code on each commit).
 
 While not strictly necessary for debugging, some debugging tools require [graphviz](https://www.graphviz.org/download/) to be installed on your system.