guitarix icon indicating copy to clipboard operation
guitarix copied to clipboard

Published 20 hours ago • verified publisher icon brummer10

Documentation

Open Rippert opened this issue 3 years ago • 3 comments

So, as I learn more about the intricacies of Guitarix, I need to start writing this stuff down. I remember Hermann was asking for help with documentation somewhere, so is there any consensus on what format the documents should be in?

Rippert avatar Apr 27 '21 06:04 Rippert

I guess it depend on how we present it. So, as part of the github repository it would properly be nice in the markdown format, as part of the source distribution it may be nice in plain text, or in html format, anyhow, any documentation, which format however is welcome and better then non documentation.

brummer10 avatar May 01 '21 15:05 brummer10

What do you think about using the GitHub WIKI? it's basically just a bunch of markdown pages and is also a separate project page that you can push and pull through git. I haven't really worked with it, but it sounds potentially useful.

Rippert avatar May 01 '21 20:05 Rippert

Yes, good idea. I've as well never work with the github wiki pages.

brummer10 avatar May 02 '21 03:05 brummer10