From b360b7bc87d88a37908e4c6b2d01d7c18a39046d Mon Sep 17 00:00:00 2001 From: Ignacio Sastre Date: Mon, 23 Mar 2026 09:17:13 -0300 Subject: [PATCH] docs(readme): add venv and update pypi source --- README.md | 17 +++++++++++++++-- docs/getting-started.md | 4 ++-- 2 files changed, 17 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 3fd7cee..f44d7fc 100644 --- a/README.md +++ b/README.md @@ -51,14 +51,27 @@ CogSol is designed to provide a Django-like development experience for building ## Installation -### From Source - ```bash +# Option A: Install from source git clone cogsol-framework cd cogsol-framework + +# Create and activate a virtual environment +python -m venv .venv +# Windows: +.venv\Scripts\activate +# macOS/Linux: +source .venv/bin/activate + +# Install dependencies pip install -e . + +# Option B: Install from PyPI +pip install cogsol-framework ``` +Using a local `.venv` keeps project dependencies isolated and prevents conflicts with global Python packages. + ### Requirements - Python 3.9+ diff --git a/docs/getting-started.md b/docs/getting-started.md index 2db7f72..e862cdd 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -56,8 +56,8 @@ source .venv/bin/activate # Install dependencies pip install -e . -# Option B: Install from PyPI (when available) -pip install cogsol +# Option B: Install from PyPI +pip install cogsol-framework ``` Using a local `.venv` keeps project dependencies isolated and prevents conflicts with global Python packages.