Update README with development setup instructions and roadmap improvements

This commit is contained in:
2025-09-27 05:46:45 +02:00
parent 5bc0e02cd3
commit 3ad8931ece

View File

@@ -17,6 +17,37 @@ A terminal user interface (TUI) for interacting with Ollama models, similar to `
- [Ollama](https://ollama.ai/) installed and running
- Rust 1.70+ (for building from source)
## Development Setup and Usage
To set up the project for development, follow these steps:
1. **Clone the repository:**
```bash
git clone https://somegit.dev/Owlibou/owlen.git
cd owlen
```
2. **Build the project:**
```bash
cargo build
```
This will compile all crates in the workspace.
3. **Run tests:**
```bash
cargo test
```
4. **Run the `owlen` (chat) application in development mode:**
```bash
cargo run --bin owlen
```
5. **Run the `owlen-code` (code) application in development mode:**
```bash
cargo run --bin owlen-code
```
## Installation
### Build from Source
@@ -232,6 +263,8 @@ curl http://localhost:11434/api/tags
## Roadmap
- [ ] Chat interface (`owlen`) (in progress)
- [ ] Code interface (`owlen-code`)
- [ ] Configuration file support
- [ ] Custom Ollama host configuration
- [ ] Session persistence