search

lightbend / config

configuration library for JVM languages using HOCON files
https://lightbend.github.io/config/
6.15k stars 967 forks source link

hocon for dummies #33

Open carrot-garden opened 12 years ago

carrot-garden commented 12 years ago

I just did a little edit of HOCON.md for pull 32

what struck me it is a classic tl;dr masterpeace

I suggest to provide hocon for dummies which would be just a collection of small hocon config snippets, with minimal comments, of increasing complexity, so people can pick up and use hocon patterns, w/o much technical understanding of details

havocp commented 12 years ago

I tried to make the README have a summary like that.

carrot-garden commented 12 years ago

yes, essentially I had in mind https://github.com/typesafehub/config/blob/master/README.md#examples-of-hocon

but only examples, examples, examples :-)

hrj commented 11 years ago

+1 to this. I am using the config library in my accounting system. Users of my system are not necessarily programmers.

If the examples in the Readme can be pulled out into a "user-friendly" page, I can just point a link to such a page rather than the github page which is confusing to them coughdummycough users.

havocp commented 10 years ago

I could use some help writing such a page and maybe setting up sbt-ghpages to publish it. (see https://github.com/sbt/sbt-ghpages ) I can push the publish button ...