coulomb/kaizen-agentic
2
0
Fork 0
Code Issues 4 Pull Requests Actions 1 Projects Releases Wiki Activity

Update documentation for local package installation option

Browse Source 
- 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 <noreply@anthropic.com>
This commit is contained in:
Bernd Worsch
2025-10-19 20:55:09 +02:00
parent 0f7c3a9a3c
commit 63dacda163
2 changed files with 28 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@@ -8,7 +8,7 @@ This project embraces the Japanese concept of "kaizen" (continuous improvement)
### Install the Package ### Install the Package
**From Source (Current - Development Version):** **From Source (Development):**
```bash ```bash
git clone https://github.com/kaizen-agentic/kaizen-agentic.git git clone https://github.com/kaizen-agentic/kaizen-agentic.git
cd kaizen-agentic cd kaizen-agentic
@@ -17,6 +17,15 @@ make agents-install-cli
source .venv/bin/activate 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):** **From PyPI (Coming Soon):**
```bash ```bash
pip install kaizen-agentic # Available after v1.0.0 publication pip install kaizen-agentic # Available after v1.0.0 publication

20
docs/GETTING_STARTED.md
View File

@@ -25,14 +25,30 @@ make agents-install-cli
source .venv/bin/activate 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 ```bash
# Will be available once v1.0.0 is published # Will be available once v1.0.0 is published
pip install kaizen-agentic 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 ### 2. Verify Installation