Update README with development setup instructions and roadmap improvements
This commit is contained in:
33
README.md
33
README.md
@@ -17,6 +17,37 @@ A terminal user interface (TUI) for interacting with Ollama models, similar to `
|
|||||||
- [Ollama](https://ollama.ai/) installed and running
|
- [Ollama](https://ollama.ai/) installed and running
|
||||||
- Rust 1.70+ (for building from source)
|
- 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
|
## Installation
|
||||||
|
|
||||||
### Build from Source
|
### Build from Source
|
||||||
@@ -232,6 +263,8 @@ curl http://localhost:11434/api/tags
|
|||||||
|
|
||||||
## Roadmap
|
## Roadmap
|
||||||
|
|
||||||
|
- [ ] Chat interface (`owlen`) (in progress)
|
||||||
|
- [ ] Code interface (`owlen-code`)
|
||||||
- [ ] Configuration file support
|
- [ ] Configuration file support
|
||||||
- [ ] Custom Ollama host configuration
|
- [ ] Custom Ollama host configuration
|
||||||
- [ ] Session persistence
|
- [ ] Session persistence
|
||||||
|
|||||||
Reference in New Issue
Block a user