Add note about installation C caveat

- Installation with plain pip is not possible
NERDSITU · Jun 17, 2024 · 671f22a · 671f22a
1 parent 2b083ad
commit 671f22a
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -37,6 +37,8 @@ to create the virtual environment `sb_env`:
 conda create -n sb_env -c conda-forge python=3.12 osmnx=1.9.2
 ```
 
+> **Note:** While `pip` can install OSMnx, it's not officially supported due to potential issues with C dependencies. If unsure, use `conda` as instructed above to avoid problems. 
+
 *Alternatively*, or if you run into
 issues, [clone this repository](https://github.com/NERDSITU/superblockify/archive/refs/heads/main.zip)
 and create the environment via

diff --git a/docs/installation.md b/docs/installation.md
@@ -11,10 +11,11 @@ to create the virtual environment `sb_env`:
 conda create -n sb_env -c conda-forge python=3.12 osmnx=1.9.2
 ```
 
+> **Note:** While `pip` can install OSMnx, it's not officially supported due to potential issues with C dependencies. If unsure, use `conda` as instructed above to avoid problems.
+
 *Alternatively*, or if you run into issues, [clone this repository](https://github.com/NERDSITU/superblockify/archive/refs/heads/main.zip) and create the environment via
 the [`environment.yml`](https://github.com/NERDSITU/superblockify/blob/main/environment.yml)
 file:
-:
 
 ```bash
 conda env create --file environment.yml