diff --git a/FIXES_APPLIED.md b/FIXES_APPLIED.md new file mode 100644 index 0000000000..964e4070e8 --- /dev/null +++ b/FIXES_APPLIED.md @@ -0,0 +1,27 @@ +# Fixes Applied to Aden Hive + +This document lists the fixes that were applied to address the identified issues. + +## Issues Identified & Fixes Applied: + +### 1. **uv Installation** (`README.md` and `docs/getting-started.md`) +- **Issue**: Users try to run `./quickstart.sh` but `uv` is not installed +- **Fix**: Added `pip install uv` instruction before cloning and running quickstart + +### 2. **Windows Quickstart** (`README.md` and `docs/getting-started.md`) +- **Issue**: No clear Windows instructions - users try to run `./quickstart.sh` on Windows +- **Fix**: Added Windows-specific section showing `.\quickstart.ps1` in PowerShell + +### 3. **TUI Deprecation** (`docs/getting-started.md`) +- **Issue**: Shows `hive tui` commands but TUI is deprecated (per AGENTS.md) +- **Fix**: Added deprecation notice in Next Steps section recommending `hive open` instead + +--- + +## Summary: +Apply these fixes to your local copy and submit as a PR to demonstrate understanding of the codebase and attention to detail. + +## Files Modified: +1. `README.md` - Added uv installation and Windows quickstart instructions +2. `docs/getting-started.md` - Added uv installation, Windows quickstart, and TUI deprecation notice + diff --git a/README.md b/README.md index 6cf202a346..f0bb12238d 100644 --- a/README.md +++ b/README.md @@ -94,13 +94,18 @@ Use Hive when you need: > Please use the quickstart script below to set up the environment. ```bash +# Install uv first (required) +pip install uv + # Clone the repository git clone https://github.com/aden-hive/hive.git cd hive - -# Run quickstart setup +# Run quickstart setup (Linux/macOS) ./quickstart.sh + +# On Windows, use PowerShell instead: +# .\quickstart.ps1 ``` This sets up: diff --git a/docs/getting-started.md b/docs/getting-started.md index d6ee2451d4..c5142f0947 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -14,13 +14,20 @@ This guide will help you set up the Aden Agent Framework and build your first ag The fastest way to get started: ```bash +# Install uv first (required) +pip install uv + # 1. Clone the repository git clone https://github.com/adenhq/hive.git cd hive # 2. Run automated setup +# On Linux/macOS: ./quickstart.sh +# On Windows (PowerShell): +# .\quickstart.ps1 + # 3. Verify installation (optional, quickstart.sh already verifies) uv run python -c "import framework; import aden_tools; print('✓ Setup complete')" ``` @@ -181,13 +188,15 @@ PYTHONPATH=exports uv run python -m my_agent test --type success ## Next Steps -1. **Dashboard**: Run `hive open` to launch the web dashboard, or `hive tui` for the terminal UI +1. **Dashboard**: Run `hive open` to launch the web dashboard (recommended) 2. **Detailed Setup**: See [environment-setup.md](./environment-setup.md) 3. **Developer Guide**: See [developer-guide.md](./developer-guide.md) 4. **Build Agents**: Use `/hive` skill in Claude Code 5. **Custom Tools**: Learn to integrate MCP servers 6. **Join Community**: [Discord](https://discord.com/invite/MXE49hrKDk) +> **Note:** The TUI (`hive tui`) is deprecated. Use `hive open` for the web dashboard instead. + ## Troubleshooting ### ModuleNotFoundError: No module named 'framework'