cbt icon indicating copy to clipboard operation
cbt copied to clipboard

readme generation

Open cvogt opened this issue 8 years ago • 5 comments

allow generating github readmes from templates adding common content like latest maven version build too config, etc. And auto include relevant badges: http://shields.io/

cvogt avatar Jun 21 '16 20:06 cvogt

http://www.lihaoyi.com/Scalatex/ may be a good templating language here. Or https://scalate.github.io/scalate/

cvogt avatar Jun 23 '16 18:06 cvogt

@olafurpg you mention a "Scalatex readme project" in https://github.com/lihaoyi/sourcecode/pull/15 Where is that? This sounds very similar.

cvogt avatar Oct 02 '16 19:10 cvogt

@cvogt The "readme" is the http://scalafmt.org website using scalatex site. Sources for for that project: https://github.com/olafurpg/scalafmt/tree/master/readme

Scalatex is awesome because it's just code, which makes it easy to things that you would typically achieve in markdown with hacky extensions. For example, you can easily pull latest version number from the build and use that in the generated readme/docs.

It still seems most people love markdown. Tut is popular choice to produce typechecked .md files.

olafurpg avatar Oct 02 '16 20:10 olafurpg

All with you on the awesomeness of Scalatex.

cvogt avatar Oct 03 '16 19:10 cvogt

I'm planning to migrate my sbt-hepek to CBT also. Which should be trivial, since it is just ~100 lines of code. It's similar to Scalatex but pure Scala, kinda follows CBT's way of doing stuff. 😄

sake92 avatar Jan 14 '18 20:01 sake92