better-files icon indicating copy to clipboard operation
better-files copied to clipboard

Document README using mdoc

Open pathikrit opened this issue 9 years ago • 5 comments

https://github.com/tpolecat/tut

pathikrit avatar Sep 24 '15 07:09 pathikrit

I think it is a great time to make this happen. The current README has many errors that don't work if they are copy and pasted into a REPL. Tut would fix this. :-)

jarrodu avatar Dec 23 '17 18:12 jarrodu

PRs welcome :)

pathikrit avatar Dec 23 '17 18:12 pathikrit

Lol, Maybe. You opened the issue in 2015. ;-)

In particular how do I use the ShapelessScanner without publishing the jar locally?

jarrodu avatar Dec 23 '17 18:12 jarrodu

The plan is in v4 to extract the scanner to a standalone module which depends on shapeless. Currently it is only 5 lines of code under MIT license so feel free to copy-paste it in your codebase: https://github.com/pathikrit/better-files/blob/master/shapeless/src/main/scala/better/files/ShapelessScanner.scala

pathikrit avatar Dec 23 '17 19:12 pathikrit

https://scalameta.org/mdoc/docs/installation.html

pathikrit avatar Dec 30 '18 16:12 pathikrit