docs: add environment setup tips and OpenAI/Grok config examples to README

Browse Source 
The diff adds a tip about creating bash files for environment variables and symlinking them for easy access, along with new configuration sections for OpenAI (using gpt-4o-mini) and Grok (using grok-2 with strict mode disabled) API setups in the README documentation.
This commit is contained in:
retoor 2025-04-08 08:22:47 +00:00
parent 7046b3e551
commit f786943906
1 changed files with 18 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@ -24,6 +24,8 @@ R Vibe Tool is a powerful Command-Line Interface (CLI) utility designed for Linu
### Environment Variables
TIP: create bash files containg these variables and make them easily accessable. For example by symlinking them to `~/.bash_aliases` or `~/.bash_profile`. Or even easier, make them executable and put them in /usr/local/bin.
#### Ollama Configuration
```bash
export R_MODEL="qwen2.5:3b"
@ -39,6 +41,22 @@ export R_KEY="sk-ant-[your-key]"
./r
```
#### OpenAI Configuration
```bash
export R_MODEL="gpt-4o-mini"
export R_BASE_URL="https://api.openai.com"
export R_KEY="sk-[your-key]"
./r
```
#### Grok Configuration
```bash
export R_MODEL="grok-2"
export R_BASE_URL="https://api.x.ai"
export R_USE_STRICT=false
export R_KEY="xai-gfh"
```
## Best Practices
1. Use `~/.rcontext.txt` to define specific behavioral instructions