From 1f88da34cdc4ef21e3dcd922b234f3b282723dc9 Mon Sep 17 00:00:00 2001
From: Claude <noreply@anthropic.com>
Date: Sat, 8 Nov 2025 04:28:48 +0000
Subject: [PATCH] Update README installation documentation

- Fix syntax error in pip install command
- Replace deprecated setup.py install with modern pip install
- Add Python version requirements (>=3.7)
- Reorganize into clear sections for PyPI and source installation
- Add editable mode installation for development
- Include cross-platform virtual environment activation instructions
---
 README.md | 36 +++++++++++++++++++++++++++++-------
 1 file changed, 29 insertions(+), 7 deletions(-)

diff --git a/README.md b/README.md
index 4a7c16f..046e288 100644
--- a/README.md
+++ b/README.md
@@ -3,16 +3,38 @@
 
 ## Installation
 
-Install using pip
-```
+### Requirements
+- Python >= 3.7
+- CUDA-compatible GPU (optional, but recommended for faster training)
+
+### Install from PyPI
+
+Install the latest stable version using pip:
+```bash
 pip install genevector
 ```
-or install from Github
-```
+
+### Install from Source
+
+For the latest development version, install directly from GitHub:
+
+```bash
+# Clone the repository
+git clone https://github.com/nceglia/genevector.git
+cd genevector
+
+# Create and activate a virtual environment (recommended)
 python3 -m venv gvenv
-source gvenv/bin/activate
-python3 pip install -r requirements.txt
-python3 setup.py install
+source gvenv/bin/activate  # On Windows: gvenv\Scripts\activate
+
+# Install dependencies and package
+pip install -r requirements.txt
+pip install .
+```
+
+For development, install in editable mode:
+```bash
+pip install -e .
 ```
 ## Tutorials (see "example" directory)