From 3df18d20a385a1d8d0b69eaac6a9a0873dae8adb Mon Sep 17 00:00:00 2001
From: Changho Hwang <changhohwang@microsoft.com>
Date: Thu, 31 Aug 2023 02:40:40 +0900
Subject: [PATCH] Update install guidelines (#159)

---
 docs/quickstart.md | 19 ++++++++++++++-----
 1 file changed, 14 insertions(+), 5 deletions(-)

diff --git a/docs/quickstart.md b/docs/quickstart.md
index 37d5ed774..585800236 100644
--- a/docs/quickstart.md
+++ b/docs/quickstart.md
@@ -15,7 +15,7 @@
 
 ## Build from Source
 
-CMake 3.26 or later is required.
+CMake 3.25 or later is required.
 
 ```bash
 $ git clone https://github.com/microsoft/mscclpp.git
@@ -24,15 +24,23 @@ $ cmake -DCMAKE_BUILD_TYPE=Release ..
 $ make -j
 ```
 
-## Install from Source
+## Install from Source (Libraries and Headers)
 
 ```bash
 # Install the generated headers and binaries to /usr/local/mscclpp
-$ cmake -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=/usr/local/mscclpp ..
-$ make -j mscclpp
+$ cmake -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=/usr/local/mscclpp -DBUILD_PYTHON_BINDINGS=OFF ..
+$ make -j mscclpp mscclpp_static
 $ sudo make install/fast
 ```
 
+## Install from Source (Python Module)
+
+Python 3.8 or later is required.
+
+```bash
+$ python -m pip install .
+```
+
 ## Docker Images
 
 Our base image installs all prerequisites for MSCCL++.
@@ -65,9 +73,10 @@ $ mpirun -np 16 -npernode 8 -hostfile hostfile ./test/mp_unit_tests -ip_port 10.
 
 ## mscclpp-test
 
-mscclpp-test is a set of performance benchmarks for MSCCL++. It requires MPI to be installed on the system.
+mscclpp-test is a set of performance benchmarks for MSCCL++. It requires MPI to be installed on the system, and the path should be provided via `MPI_HOME` environment variable to the CMake build system.
 
 ```bash
+$ MPI_HOME=/path/to/mpi cmake -DCMAKE_BUILD_TYPE=Release ..
 $ make -j sendrecv_test_perf allgather_test_perf allreduce_test_perf alltoall_test_perf
 ```