diff options
author | David Robillard <d@drobilla.net> | 2012-12-31 23:10:27 +0000 |
---|---|---|
committer | David Robillard <d@drobilla.net> | 2012-12-31 23:10:27 +0000 |
commit | 4a603a28de272c818100185ffbc8693585d7be9f (patch) | |
tree | bf8cbadb49bfefd61776185a3e20b192c2a0c64a /plugins/README.txt | |
parent | b09f94596a7361f01b835d811e14269ecec5272a (diff) | |
download | lv2-4a603a28de272c818100185ffbc8693585d7be9f.tar.xz |
Generate book from example plugin source.
Diffstat (limited to 'plugins/README.txt')
-rw-r--r-- | plugins/README.txt | 26 |
1 files changed, 26 insertions, 0 deletions
diff --git a/plugins/README.txt b/plugins/README.txt new file mode 100644 index 0000000..7eb25d8 --- /dev/null +++ b/plugins/README.txt @@ -0,0 +1,26 @@ += Programming LV2 Plugins = +David Robillard <d@drobilla.net> +:Author Initials: DER +:toc: +:website: http://lv2plug.in/ +:doctype: book + +== Introduction == + +This is a series of well-documented example plugins that demonstrate the various features of LV2. +Starting with the most basic plugin possible, +each adds new functionality and explains the features used from a high level perspective. + +API and vocabulary reference documentation explains details, +but not the ``big picture''. +This book is intended to complement the reference documentation by providing good reference implementations of plugins, +while also conveying a higher-level understanding of LV2. + +The chapters/plugins are arranged so that each builds incrementally on its predecessor. +Reading this book front to back is a good way to become familiar with modern LV2 programming. +The reader is expected to be familiar with C, but otherwise no special knowledge is required; +the first plugin describes the basics in detail. + +This book is compiled from plugin source code into a single document for pleasant reading and ease of reference. +Each chapter corresponds to executable plugin code which can be found in the +plugins+ directory of the LV2 distribution. +If you prefer to read actual source code, all the content here is also available there, where the book text is included in comments. |