-
-
Notifications
You must be signed in to change notification settings - Fork 54
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
Add some basic usage documentation to the README #19
Comments
autogenerated with https://github.com/MalloZup/doghub: issue inactive since 450 days. Please update the issue or close it |
Between https://github.com/clojure-emacs/orchard#design and https://github.com/clojure-emacs/orchard#api-documentation it looks like we're well served :) cljdoc fix is kind of in its way cljdoc/cljdoc#487 |
I meant this ticket more in the sense of explaining what the various APIs are supposed to do with more prose. Something like an overview of namespaces and essential functions, but I guess good ns and function docstrings, plus working cljdoc would be a good enough solution. Generally my concern is that few people will understand from the README how are they supposed to use Orchard. |
I agree with @bbatsov. I was confused when I first found orchard through nrpel. |
Alright let's see what we can do :) I agree with |
We should probably add a least a couple of sections regarding the high-level usage of
orchard
and the goals of the project.The text was updated successfully, but these errors were encountered: