-
Notifications
You must be signed in to change notification settings - Fork 127
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
more concrete example? #10
Comments
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. |
I agree. In fact, a comment in #7 mentioning progress before finishing it mentions the same goal. |
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.
The text was updated successfully, but these errors were encountered: