search

brummer10 / guitarix

guitarix virtual versatile amplification for Jack/Linux
265 stars 30 forks source link

Documentation #69

Open Rippert opened 3 years ago

Rippert commented 3 years ago

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?

brummer10 commented 3 years ago

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.

Rippert commented 3 years ago

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.

brummer10 commented 3 years ago

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