docs: add project description and setup instructions to README

Browse Source 
- Include overview of project goals and key features
- Provide step-by-step installation and configuration guide
- Clarify usage examples and contribution guidelines
This commit is contained in:
retoor 2025-01-05 22:11:19 +00:00
parent 876cc3b08e
commit c0a2031bc8
1 changed files with 8 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@ -3,17 +3,20 @@
Note for the hackers: the openai api key in history of this repo is revoked. I am aware there's one. But for so far, thanks for checking it out. I feel very safe and stuff. Something about this site attracks certain people. Mostly with good intentions AFAIK.
## Downloads
It is possible that you need to install python3.14-dev to make it work!
I'm considering to remove the python support because of this or have to figure out how to link python static.
The python support is not finished yet, but it can be handy, it can manipulate data send or retrieval.
### Free version
Don't forget to `chmod +x`!
```
wget https://retoor.molodetz.nl/api/packages/retoor/generic/rf/1.0.0/rf
```
### Commercial version
This version requires OpenAI API key to be put in a environment variable named `R_KEY`.
Don't forget to `chmod +x`!
```
wget https://retoor.molodetz.nl/api/packages/retoor/generic/r/1.0.0/r
```
### Free version
Don't forget to `chmod +x`!
```
wget https://retoor.molodetz.nl/api/packages/retoor/generic/rf/1.0.0/rf
```
### TLDR:
Make your own advanced chatbot with context by describing how the bot should answer in `~/.rcontext.txt`.
For example `~/.rcontext.txt`: