Example readme and some light refactoring

[mgroeber9110]

I have tried to take a first stab at writing a brief README for main.exe ( #518).

While trying to untangle the --instruct and --interactive behaviour, I noticed a small inconsistency in the naming of internal parameters: There is params.interactive_start, while the command line parameter is called --interactive_first, and there is also an --interactive_start that, confusingly, does the same as --interactive.

So, I added a small refactoring change to rename the structure member for consistency.

Feedback is very welcome. If this looks reasonable, I can also try the same at least for perplexity and embeddings.

[sw]

Thanks for putting in the work of writing docs, which many devs don't like to do ;-)

I think --interactive-start could be removed, as it does the same as --interactive and isn't documented.

Alternatively, have --interactive-start for setting params.interactive_start, and remove --interactive-first.

[sw]

We might also want to shorten the top-level readme a bit, if there's duplicate information now. We can add a link to examples/main/README.md instead.

[DannyDaemonic]

This is unfortunate. I was working on this myself. Mine is at #1139.

This is actually pretty decent. I noticed some spelling errors.
seemlessly -> seamlessly
randon -> random
somehwat -> somewhat
candiates -> candidates

[Green-Sky]

but does this actually fist interactive-first? i realized it was broken recently

[mgroeber9110]

but does this actually fist interactive-first? i realized it was broken recently

It seems to work for me, at least to the extent where it stops after the first prompt, even if it does not end in a reverse prompt. Is there anything specific where it does not work?

[mgroeber9110]

I have merged a few details to the new README that I think might be worth keeping (as it took me a while to figure them out). If this gets too detailed, I am fine with taking them out again.

In addition, I added a link from the top-level README to increase visibility a bit.