From 2d4c19dc05b7288633708d4ea6fedf567f5c37e4 Mon Sep 17 00:00:00 2001 From: "Steinar H. Gunderson" Date: Tue, 8 Nov 2016 00:17:09 +0100 Subject: [PATCH] Write more introductory material. --- gettingstarted.rst | 169 +++++++++++++++++++++++++++++++++++++++- images/basic-ui.png | Bin 0 -> 617112 bytes images/context-menu.png | Bin 0 -> 15970 bytes index.rst | 3 +- meintro.rst | 26 ------- 5 files changed, 168 insertions(+), 30 deletions(-) create mode 100644 images/basic-ui.png create mode 100644 images/context-menu.png delete mode 100644 meintro.rst diff --git a/gettingstarted.rst b/gettingstarted.rst index c73686b..463a4b3 100644 --- a/gettingstarted.rst +++ b/gettingstarted.rst @@ -1,2 +1,167 @@ -Getting started with the Nageru UI (not written yet) -==================================================== +Getting started +=============== + +Welcome to Nageru! For simple use, you can jump right in and make yourself +comfortable (at least if you have the :doc:`hardware requirements ` +in place), but if you prefer a gentler introduction, this is the place. + + +Introduction to the M/E workflow +-------------------------------- + +Nageru, like most hardware video mixers, is based on the **mixer/effects** +workflow, or just M/E for short. (Don't ask why “mixer” or “effects”; +the name is confusing and mostly historical.) + +The basic idea of M/E is that you have two main displays, *preview* and *live*. +Every time you want to change what's shown to the viewer, you first bring it +up on the preview display, verify that it indeed contains something you'd like +to show to your viewers, and only then start a transition to move the preview +display onto the live display (which mirrors exactly what the viewers see). +After the transition is done, the preview and live displays switch, allowing +the operator to either switch back or to pull a new source onto the preview +display. + +In Nageru, the available transitions at any time are governed by the +:doc:`theme `. However, generally a simple cut (moving immediately +from live to preview) will nearly always be an option. Other effects include +fades and zooms, but availability will depend on what sources are involved in the +transition. + + +A brief tour of the Nageru UI +----------------------------- + +The basic Nageru UI with the default theme looks like this: + +.. image:: images/basic-ui.png + +First a word about user input: Nageru can be controlled by the mouse or +keyboard, but most operators will prefer using both hands on the keyboard. +Like on a real mixing console, you use your left hand to select sources for +preview (using the 1–9 keys) and the right hand to choose a transition +(using J, K or L). In addition, audio can be controlled using a MIDI controller +if you want to; see the :doc:`audio