Update contributing guide and remove setup_dev.py

Close #676
pdm-project · Oct 23, 2021 · cf460ec · cf460ec
1 parent d24e2af
commit cf460ec
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 72 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -53,16 +53,18 @@ $ git lfs install
 $ git lfs pull
 ```
 
-Then, you need to install base dependencies in a venv. Although PDM uses a local package directory to install
-dependencies, venv is still needed to start up PDM for the first time:
+Then, you need to install base dependencies in a venv. Make sure your `pip` is no later than `21.3` to install PDM in
+develop/editable mode.
 
 ```bash
-$ python setup_dev.py
+$ pip install -e .
 ```
 
-Now, all dependencies are installed into the local `__pypackages__` directory, which will be used for development
-after this point. The `pdm` executable located at `__pypackages__/<VERSION>/bin` can be run directly from outside,
-which is installed in editable mode, or you can use `python -m pdm` from inside the venv.
+You are free to create a virtualenv with either `venv` module or `virtualenv` tool for the development. If you are doing
+so, you may also need to set `pdm config use_venv true` after installation is done.
+
+Now, all dependencies are installed into the Python environment you choose, which will be used for development
+after this point.
 
 ### Run tests
 

diff --git a/news/676.doc.md b/news/676.doc.md
@@ -0,0 +1 @@
+Update the contributing guide, remove the usage of `setup_dev.py` in favor of `pip install`.
diff --git a/setup_dev.py b/setup_dev.py
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		Update the contributing guide, remove the usage of `setup_dev.py` in favor of `pip install`.