Add comprehensive README for monorepo
This commit is contained in:
parent
81575a0b4c
commit
5e7131ba2c
|
|
@ -0,0 +1,47 @@
|
||||||
|
# Ollie Monorepo
|
||||||
|
|
||||||
|
This repository contains all Ollie projects as submodules:
|
||||||
|
|
||||||
|
- **core/** – The core Ollie agent library (`ollie-core`)
|
||||||
|
- **tui/** – Terminal UI frontend (`ollie-tui`)
|
||||||
|
- **9p/** – 9p filesystem server (`ollie-9p`)
|
||||||
|
- **el/** – Emacs Lisp interface (`ollie-el`)
|
||||||
|
|
||||||
|
## Getting Started
|
||||||
|
|
||||||
|
Clone with submodules:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git clone --recurse-submodules https://github.com/lneely/ollie.git
|
||||||
|
```
|
||||||
|
|
||||||
|
Or after cloning:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git submodule update --init --recursive
|
||||||
|
```
|
||||||
|
|
||||||
|
## Building
|
||||||
|
|
||||||
|
Each submodule is a standalone Go project:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
cd core && mk
|
||||||
|
cd ../tui && mk
|
||||||
|
cd ../9p && mk
|
||||||
|
```
|
||||||
|
|
||||||
|
## Development
|
||||||
|
|
||||||
|
Update all submodules to latest:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git submodule update --remote
|
||||||
|
```
|
||||||
|
|
||||||
|
## Project Structure
|
||||||
|
|
||||||
|
- `core/`: Core agent library (Go)
|
||||||
|
- `tui/`: Terminal UI (Go)
|
||||||
|
- `9p/`: 9p filesystem server (Go)
|
||||||
|
- `el/`: Emacs Lisp interface (Emacs Lisp)
|
||||||
Loading…
Reference in New Issue