76 lines
2.0 KiB
Markdown
76 lines
2.0 KiB
Markdown
# Ollie Monorepo
|
||
|
||
This repository contains all Ollie projects as submodules:
|
||
|
||
- **core/** – The core Ollie agent library ([ollie-core](https://github.com/lneely/ollie-core))
|
||
- **tui/** – Terminal UI frontend ([ollie-tui](https://github.com/lneely/ollie-tui))
|
||
- **9p/** – 9p filesystem server ([ollie-9p](https://github.com/lneely/ollie-9p))
|
||
- **el/** – Emacs Lisp interface ([ollie-el](https://github.com/lneely/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
|
||
|
||
Build everything from the monorepo root:
|
||
|
||
```bash
|
||
mk
|
||
```
|
||
|
||
Or build specific components:
|
||
|
||
```bash
|
||
mk core # Build core library
|
||
mk tui # Build terminal UI
|
||
mk 9p # Build 9p filesystem server
|
||
```
|
||
|
||
For Emacs Lisp, load `el/ollie.el` in Emacs.
|
||
|
||
## Development
|
||
|
||
Update all submodules to latest:
|
||
|
||
```bash
|
||
git submodule update --remote
|
||
```
|
||
|
||
## Project Links
|
||
|
||
- **Monorepo**: [github.com/lneely/ollie](https://github.com/lneely/ollie)
|
||
- **Core Library**: [github.com/lneely/ollie-core](https://github.com/lneely/ollie-core)
|
||
- **Terminal UI**: [github.com/lneely/ollie-tui](https://github.com/lneely/ollie-tui)
|
||
- **9p Server**: [github.com/lneely/ollie-9p](https://github.com/lneely/ollie-9p)
|
||
- **Emacs Lisp**: [github.com/lneely/ollie-el](https://github.com/lneely/ollie-el)
|
||
|
||
## Project Structure
|
||
|
||
- `core/`: Core agent library (Go)
|
||
- `tui/`: Terminal UI (Go)
|
||
- `9p/`: 9p filesystem server (Go)
|
||
- `el/`: Emacs Lisp interface (Emacs Lisp)
|
||
## Credits
|
||
|
||
Many sources of inspiration:
|
||
|
||
- [Plan 9 from Bell Labs](https://9fans.net) — for an interesting system
|
||
- [@9fans](https://github.com/9fans) — for the Plan 9 port
|
||
- [Suckless](https://suckless.org) — for articulating good software development principles
|
||
- [@simonfxr](https://github.com/simonfxr) — for a solid agent baseline to "borrow" from, and other nifty ideas
|
||
- [@aws](https://github.com/aws/amazon-q-developer-cli) — for a solid open-source agent implementation
|
||
|
||
## License
|
||
|
||
GPLv3 |