diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..141dc27 --- /dev/null +++ b/.gitignore @@ -0,0 +1,3 @@ +# Any and all HTML and PDF files should be left out of the Git index +*.html +*.pdf diff --git a/Glossary.adoc b/Glossary.adoc index 699d0e8..3b5ca99 100644 --- a/Glossary.adoc +++ b/Glossary.adoc @@ -2,4 +2,4 @@ // We need to figure out a way to sort the items here alphabetically // https://github.com/zynaddsubfx/user-manual/issues/6 -NOTE: Here by glossary! \ No newline at end of file +NOTE: Here by glossary! diff --git a/Goals.adoc b/Goals.adoc index e27d170..a93c596 100644 --- a/Goals.adoc +++ b/Goals.adoc @@ -1,5 +1,7 @@ === Goals of this User Manual -If we want to create a decent user manual, we need t understand why is it needed, who is going to use it and what do they expect. Let's first try to see who and why would want to read the user manual and what would they need to be satisfied with their experience. + +If we want to create a decent user manual, we need to understand why is it needed, who is going to use it and what do they expect. Let's first try to see who and why would want to read the user manual and what would they need to be satisfied with their experience. + ## Who will read it - and what for? * Potential new experienced users - to determine if Zyn-Fusion is the right tool for them, to see the limitations and possibilities of Zyn-Fusion - to see if it's worth dedicating time and money to integrate it in their workflow, @@ -49,7 +51,6 @@ $ import -window "ZynAddSubFX 3.0.3" Zyn.png $ display Zyn.png -------------------------------------------------------------------------------- - As long as the default Zyn-Fusion window size (or proportions are not going to change we can simply run `zynaddsubfx` to prepare a screenshot. If this is subject to change we could override the window size with another command. @@ -84,5 +85,5 @@ The only thing that changes is the subdirectory name and file contents. Thus ref -------------------------------------------------------------------------------- - + The standard _A B C D_ names might be changed if something else proves to be more convenient. They key is to keep this consistent after a scheme is picked, or the system will break, will require tons of manual labor and we will gain nothing. diff --git a/README.md b/README.md index 81858bb..26eb583 100644 --- a/README.md +++ b/README.md @@ -1,25 +1,26 @@ # Zyn-Fusion User Manual -User manual (this may or may not get merged into zynaddsubfx/zynaddsubfx's doc dir) This repository contains the user manual for Zyn-Fusion (ZynAddSubFX). +This may or may not get merged into zynaddsubfx/zynaddsubfx's doc dir. + ## Tools of the trade -The Manual is in `AsciiDoc` format https://powerman.name/doc/asciidoc +The Manual is in [`AsciiDoc` format](https://powerman.name/doc/asciidoc). -For a powerful editor with live preview for Linux, check `AsciidocFX` https://github.com/asciidocfx/AsciidocFX +For a powerful editor with live preview for Linux, check [`AsciidocFX`](https://github.com/asciidocfx/AsciidocFX). -If you need a different tool, look here: https://asciidoctor.org/docs/editing-asciidoc-with-live-preview/ +If you need a different tool, look [here](https://asciidoctor.org/docs/editing-asciidoc-with-live-preview/). ## Files -`Manual.adoc` is the main document, which uses `include` statements to pull chapters from individual files. +[`Manual.adoc`](./Manual.adoc) is the main document, which uses `include` statements to pull chapters from individual files. -`Goals.adoc` is a document for the manual writers, to define a coherent idea of what the Manual should be like. +[`Goals.adoc`](./Goals.adoc) is a document for the manual writers, to define a coherent idea of what the Manual should be like. ## How to contribute? -If you'd like to share your knowledge about ZynAddSubFX and help fill in the gaps of this User Manual - first take a look at the Manual.adoc file and read. +If you'd like to share your knowledge about ZynAddSubFX and help fill in the gaps of this User Manual - first take a look at the `Manual.adoc` file and read. When you'll find something that you feel comfortable writing about, find the appropriate `.adoc` chapter file and contribute there. @@ -31,7 +32,7 @@ Every line starting with `//` is regarded as a comment. Multi-line text enclosed between lines containing only `////` is regarded as a comment to. // example one line comment - + //// example multi-line @@ -43,4 +44,3 @@ If you have any questions, or suggestions - feel free to create an Issue, and li // Here goes all the term definitions the user might need to reference while reading the manual. // We need to figure out a way to sort the items here alphabetically // https://github.com/zynaddsubfx/user-manual/issues/6 -