search

Cormanz / smartgpt

A program that provides LLMs with the ability to complete complex tasks using plugins.
MIT License
1.75k stars 127 forks source link

more concrete example? #10

Open ClaireCJS opened 1 year ago

ClaireCJS commented 1 year ago

Would it be possible to provide a more concrete example of how to use it, in the README file?

Like an example where we ask it a specific question and save the result as a file (though STDOUT would be good enough, honestly!).

Alas, the README was just slightly over my head, but only slightly.

Cormanz commented 1 year ago

I think that's a great idea. I'm planning to significantly overhaul the README, so I'll try to simplify it and provide more useful use-cases. I do want to note though that this is still a very experimental project, so a lot of our time is mostly spent on rapid prototyping rather than polishing and showing uses.

Thanks for your enthusiasm!

orvitpng commented 1 year ago

I think that's a great idea. I'm planning to significantly overhaul the README, so I'll try to simplify it and provide more useful use-cases. I do want to note though that this is still a very experimental project, so a lot of our time is mostly spent on rapid prototyping rather than polishing and showing uses.

Thanks for your enthusiasm!

I recommend documenting outside the README. README should be for general knowledge that everyone should know for this.

Cormanz commented 1 year ago

I recommend documenting outside the README. README should be for general knowledge that everyone should know for this.

I agree. In fact, a comment in #7 mentioning progress before finishing it mentions the same goal.