From 63dacda16304bab1bcbd60ada2ea389390a1021a Mon Sep 17 00:00:00 2001 From: tegwick Date: Sun, 19 Oct 2025 20:55:09 +0200 Subject: [PATCH] Update documentation for local package installation option MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - Add Option B: From Local Package installation instructions - Include make install-local target in both README.md and GETTING_STARTED.md - Provide clear path for testing PyPI-equivalent installation locally - Maintains development, local package, and future PyPI installation options 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude --- README.md | 11 ++++++++++- docs/GETTING_STARTED.md | 20 ++++++++++++++++++-- 2 files changed, 28 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 566eb49..9c370d4 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ This project embraces the Japanese concept of "kaizen" (continuous improvement) ### Install the Package -**From Source (Current - Development Version):** +**From Source (Development):** ```bash git clone https://github.com/kaizen-agentic/kaizen-agentic.git cd kaizen-agentic @@ -17,6 +17,15 @@ make agents-install-cli source .venv/bin/activate ``` +**From Local Package (Test Installation):** +```bash +git clone https://github.com/kaizen-agentic/kaizen-agentic.git +cd kaizen-agentic +make setup-complete +python3 -m build && make install-local +source .venv/bin/activate +``` + **From PyPI (Coming Soon):** ```bash pip install kaizen-agentic # Available after v1.0.0 publication diff --git a/docs/GETTING_STARTED.md b/docs/GETTING_STARTED.md index 49323dc..ed9c033 100644 --- a/docs/GETTING_STARTED.md +++ b/docs/GETTING_STARTED.md @@ -25,14 +25,30 @@ make agents-install-cli source .venv/bin/activate ``` -**Option B: From PyPI (Coming Soon)** +**Option B: From Local Package (Test PyPI Installation)** + +```bash +# Clone the repository and build package +git clone https://github.com/kaizen-agentic/kaizen-agentic.git +cd kaizen-agentic +make setup-complete + +# Build and install from local package +python3 -m build +make install-local + +# Activate virtual environment +source .venv/bin/activate +``` + +**Option C: From PyPI (Coming Soon)** ```bash # Will be available once v1.0.0 is published pip install kaizen-agentic ``` -> **📦 Release Status**: v1.0.0 is ready for publication. See our [release workflow](../Makefile) with `make release-*` targets. +> **📦 Release Status**: v1.0.0 is ready for publication. Test local installation with `make install-local` before PyPI publication. ### 2. Verify Installation