Files

vikingowl 5b202fed4f Add comprehensive documentation and examples for Owlen architecture and usage

- Include detailed architecture overview in `docs/architecture.md`.
- Add `docs/configuration.md`, detailing configuration file structure and settings.
- Provide a step-by-step provider implementation guide in `docs/provider-implementation.md`.
- Add frequently asked questions (FAQ) document in `docs/faq.md`.
- Create `docs/migration-guide.md` for future breaking changes and version upgrades.
- Introduce new examples in `examples/` showcasing basic chat, custom providers, and theming.
- Add a changelog (`CHANGELOG.md`) for tracking significant changes.
- Provide contribution guidelines (`CONTRIBUTING.md`) and a Code of Conduct (`CODE_OF_CONDUCT.md`).

2025-10-05 02:23:32 +02:00

1.9 KiB

Raw Blame History

Frequently Asked Questions (FAQ)

What is the difference between `owlen` and `owlen-code`?

owlen is the general-purpose chat client.
owlen-code is an experimental client with a system prompt that is optimized for programming and code-related questions. In the future, it will include more code-specific features like file context and syntax highlighting.

How do I use Owlen with a different terminal?

Owlen is designed to work with most modern terminals that support 256 colors and Unicode. If you experience rendering issues, you might try:

WezTerm: Excellent cross-platform, GPU-accelerated terminal.
Alacritty: Another fast, GPU-accelerated terminal.
Kitty: A feature-rich terminal emulator.

If issues persist, please open an issue and let us know what terminal you are using.

What is the setup for Windows?

The Windows build is currently experimental. However, you can install it from source using cargo if you have the Rust toolchain installed.

Install Rust from rustup.rs.
Install Git for Windows.
Clone the repository: git clone https://github.com/Owlibou/owlen.git
Install: cd owlen && cargo install --path crates/owlen-cli

Official binary releases for Windows are planned for the future.

What is the setup for macOS?

Similar to Windows, the recommended installation method for macOS is to build from source using cargo.

Install the Xcode command-line tools: xcode-select --install
Install Rust from rustup.rs.
Clone the repository: git clone https://github.com/Owlibou/owlen.git
Install: cd owlen && cargo install --path crates/owlen-cli

Official binary releases for macOS are planned.

I'm getting connection failures to Ollama.

Please see the Troubleshooting Guide for help with this common issue.

1.9 KiB Raw Blame History