lua-zlib icon indicating copy to clipboard operation
lua-zlib copied to clipboard

Published 20 hours ago • verified publisher icon brimworks

Rewrite README as markdown

Open guilhem opened this issue 10 years ago • 3 comments

Split LICENCE from readme

guilhem avatar Oct 16 '14 16:10 guilhem

also document #21 ;)

guilhem avatar Oct 16 '14 16:10 guilhem

:up: :smile:

guilhem avatar Oct 17 '14 17:10 guilhem

Sorry, I completely lost track of this pull request :(. I like the idea of using Markdown for documentation, but I'm not sure that this documentation is any better since it now looks like paragraph prose:

https://github.com/guilhem/lua-zlib/blob/487147f086addfb3615a850e67fff78dbea81a94/README.md

It would be nicer if the functions getting documented "stood out" more, perhaps by giving them headings that can easily be navigated to? ...alternatively, perhaps I should try to use LuaDoc for documentation purposes? ...or do you have better ideas?

Thanks, -Brian

brimworks avatar Apr 14 '15 04:04 brimworks