Example README for Contrib libraries

[Stuart Sierra]

I've put together a README that I think shows all the info that contrib library READMEs should have.

https://github.com/clojure/data.json

Please suggest additional information that should be included. Contrib authors, please use this as a model for library READMEs.

-S

[Justin Kramer]

From the README:

"Refer to docstrings in the clojure.data.json namespace for additional documentation."

What's the status of API docs for new contrib? Will they be auto-generated, or is it up to contrib maintainers to create them?

Justin

[Stuart Sierra]

If somebody (e.g. Tom F.) knows how to auto-generate them and has time to set it up, I will grant whatever commit privileges they need.

-S

[Sean Corfield]

On Fri, Feb 10, 2012 at 7:25 AM, Justin Kramer <jkkr...@gmail.com> wrote:
> "Refer to docstrings in the clojure.data.json namespace for additional
> documentation."
>
> What's the status of API docs for new contrib? Will they be auto-generated,
> or is it up to contrib maintainers to create them?

Like this: http://clojure.github.com/data.json/ ?

I think all of the new libraries have autodoc pages on github. I think
there's a post-commit hook for updates?
--
Sean A Corfield -- (904) 302-SEAN
An Architect's View -- http://corfield.org/
World Singles, LLC. -- http://worldsingles.com/

"Perfection is the enemy of the good."
-- Gustave Flaubert, French realist novelist (1821-1880)

[Tom Faulhaber]

Many, but not all, of the new libraries have their autodoc on the github pages.

I'm working now to finish up type and protocol support since that is key for a bunch of the new contribs.

I have post-commit hooks for everything, I think, but I don't have them all enabled yet, so some libraries may be a little out of date.

Note that there is a general index at http://clojure.github.com. I haven't been updating this so for the moment it just represents a snapshot.

Still a bunch more work to do, but it's coming!

Enjoy,

Tom

--
You received this message because you are subscribed to the Google Groups "Clojure Dev" group.

To post to this group, send email to cloju...@googlegroups.com.
To unsubscribe from this group, send email to clojure-dev...@googlegroups.com.
For more options, visit this group at http://groups.google.com/group/clojure-dev?hl=en.

[Sean Corfield]

On Fri, Feb 10, 2012 at 6:56 AM, Stuart Sierra
<the.stua...@gmail.com> wrote:
> Please suggest additional information that should be included. Contrib
> authors, please use this as a model for library READMEs.

I have updated https://github.com/clojure/java.jdbc following that
model (and added a link to the autodoc'd page for java.jdbc). The
Change Log was a pain to recreate in markdown but it's a good model to
follow!