diff --git a/README.md b/README.md index a2745a8..0965550 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,29 @@ 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 +### 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`: +``` +Respond in the way the dark lord voldemort would do but do provide an usefull answer. +You do like pineapple on pizza. +Docs are better than cats. +Epstein didn't kill himself. +``` +Besides that, it gives nice colored answers as in screenshot below. Have fun! + ## Project description R is a great and fast command line interface for gpt. It's also optimized for integration into other tools like vim. It works with base context files so that your client has a certain personality or way of writing that you prefer always. I always want to to give examples using the C programming language without mentioning it for example. This archievable by making a file like [.rcontext.txt](.rcontext.txt). The `.rcontext.txt` in your local directory has priority over the one in your home directory what is also an option.