Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 15 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <repository-url> 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+
Expand Down
4 changes: 2 additions & 2 deletions docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
Loading