Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Documentation #69

Open
Rippert opened this issue Apr 27, 2021 · 3 comments
Open

Documentation #69

Rippert opened this issue Apr 27, 2021 · 3 comments

Comments

@Rippert
Copy link
Contributor

Rippert commented Apr 27, 2021

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
Copy link
Owner

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
Copy link
Contributor Author

Rippert commented May 1, 2021

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
Copy link
Owner

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@brummer10 @Rippert