Update README with pre-built Docker container and links
- Add Quick Start section with pre-built container option - Add Docker section with pull instructions - Add Links section (repository, Docker image, issues) 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
This commit is contained in:
parent
a5be322bf0
commit
aceb03f612
48
README.md
48
README.md
|
|
@ -15,10 +15,24 @@ A configurable GUI tool that lets users "ramble" about an idea and extracts stru
|
|||
- **Multiple providers** - Claude, Codex, Gemini, or mock for testing
|
||||
- **Headless mode** - Skip GUI, pass values directly via CLI
|
||||
|
||||
## Installation
|
||||
## Quick Start
|
||||
|
||||
### Option 1: Pre-built Docker Container
|
||||
|
||||
```bash
|
||||
# Allow X11 access
|
||||
xhost +local:docker
|
||||
|
||||
# Run the GUI with mock provider (no AI required)
|
||||
docker run -it --rm \
|
||||
-e DISPLAY=$DISPLAY \
|
||||
-v /tmp/.X11-unix:/tmp/.X11-unix \
|
||||
gitea.brrd.tech/rob/ramble --provider mock
|
||||
```
|
||||
|
||||
### Option 2: Native Install
|
||||
|
||||
```bash
|
||||
# Clone and install
|
||||
git clone https://gitea.brrd.tech/rob/ramble.git
|
||||
cd ramble
|
||||
pip install -e .
|
||||
|
|
@ -29,17 +43,31 @@ sudo apt install plantuml # For diagram rendering
|
|||
|
||||
## Docker
|
||||
|
||||
Run without installing anything locally:
|
||||
### Pre-built Image
|
||||
|
||||
```bash
|
||||
# Pull the pre-built container
|
||||
docker pull gitea.brrd.tech/rob/ramble:latest
|
||||
|
||||
# Run GUI (requires: xhost +local:docker)
|
||||
docker run -it --rm \
|
||||
-e DISPLAY=$DISPLAY \
|
||||
-v /tmp/.X11-unix:/tmp/.X11-unix \
|
||||
gitea.brrd.tech/rob/ramble --provider mock
|
||||
|
||||
# Headless mode
|
||||
docker run -it --rm gitea.brrd.tech/rob/ramble \
|
||||
--field-values '{"Title":"MyApp","Summary":"A cool app"}'
|
||||
```
|
||||
|
||||
### Build from Source
|
||||
|
||||
```bash
|
||||
# Clone the repo
|
||||
git clone https://gitea.brrd.tech/rob/ramble.git
|
||||
cd ramble
|
||||
|
||||
# Build
|
||||
docker-compose build
|
||||
|
||||
# Launch GUI (requires: xhost +local:docker)
|
||||
# Launch GUI
|
||||
docker-compose run --rm gui
|
||||
|
||||
# Headless mode
|
||||
|
|
@ -158,6 +186,12 @@ ramble/
|
|||
└── pyproject.toml
|
||||
```
|
||||
|
||||
## Links
|
||||
|
||||
- **Repository**: https://gitea.brrd.tech/rob/ramble
|
||||
- **Docker Image**: `gitea.brrd.tech/rob/ramble:latest`
|
||||
- **Issues**: https://gitea.brrd.tech/rob/ramble/issues
|
||||
|
||||
## License
|
||||
|
||||
MIT
|
||||
|
|
|
|||
Loading…
Reference in New Issue