Skip to content

Commit

Permalink
Initial commit
Browse files Browse the repository at this point in the history
Signed-off-by: falkTX <falktx@falktx.com>
  • Loading branch information
falkTX committed Feb 12, 2019
0 parents commit 04610ed
Show file tree
Hide file tree
Showing 4 changed files with 67 additions and 0 deletions.
10 changes: 10 additions & 0 deletions Introduction.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@

Carla is...

=== About the User Manual

The Manual was divided into several sections:

Introduction:: is the first part of the Manual, we're starting with an overview of the application and mowith a few simple tutorials to get the user hands-on with the synthesizer as fast as possible.
Basic Topics:: is the second part where we start to cover everything from top to bottom. If you're fairly new to Zyn-Fusion ,this part should provide you with a comprehensive, yet not overwhelming instruction.
Advanced Topics:: the third part, where we go into more detail and cover things that were skipped in the previous part. More advanced users should benefit from this part, adding depth to their understanding of the
10 changes: 10 additions & 0 deletions Manual.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
= Carla User Manual
:icons: font

== Introduction
include::Introduction.adoc[]

== Basic Topics

=== User Interface
include::UserInterface.adoc[]
45 changes: 45 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
# Carla User Manual

This repository contains the user manual for for the Carla Plugin Host.

## Tools of the trade

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

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.

`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.

When you'll find something that you feel comfortable writing about, find the appropriate `.adoc` chapter file and contribute there.

You'll find some comments that are intended as a messages to editors, not as content for end users.

In Asciidoc the comments are done as follows:

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
comment
////

If you have any questions, or suggestions - feel free to create an Issue, and link it in a comment in the appropreiate `.adoc` file. For example:

// 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

2 changes: 2 additions & 0 deletions UserInterface.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
=== Main Window
When you run Carla you'll be presented with this window:

0 comments on commit 04610ed

Please sign in to comment.