Commits

Sven Hendriks committed ed1db87

Updated READMDE.

  • Participants
  • Parent commits bb0b423

Comments (0)

Files changed (1)

 -------
 
 There are downstream depedencies that have to be fullfilled in order to install
-Lyne. On a Ubuntu box for example, you need to install the two packages 
-``python-tk`` and ``libasound2-dev`` through:
+Lyne. On a Ubuntu box for example, you need to install the packages 
+``python-tk`` and ``libasound2-dev`` as well as the Python header files through:
 
 ::
 
-    sudo apt-get install python-tk libasound2-dev
+    sudo apt-get install python-tk libasound2-dev python-dev
 
 
 You then should be able to install Lyne through
     sudo python setup.py install
 
 
+Run
+---
+
+After successful installation you should be able to run Lyne from the command
+line via
+
+::
+
+    lyne-gui
+
+Then, the Lyne application window should pop up. You start with an empty
+canvas.
+
+
+First steps
+-----------
+
+In Lyne, you basically build an arithmetic graph which consists of three types
+of nodes and connections in between. First, place a "Counter" node on the canvas
+by clicking the "Counter" button in the toolbar and then double-click somewhere
+on the canvas. You can have at most one "Counter" node and you need at least one
+to generate sound.
+
+Next, you can place any arbitrary number of "Constant" and "Operator" nodes.
+To connect to nodes, you click on the orange colored area of the source node
+which summons an arrow originating in the source node and which follows the
+mouse cursor. Next, move to the sink node and click in its orange colored area.
+The nodes should then be connected.
+
+Note: The "Counter" and "Constant" nodes have only outputs, which means you
+can not use them as sink nodes. Only "Operator" nodes have inputs and can
+therefore used as sink nodes.
+
+Each node has a speaker icon. Clicking on that icon will mark the corresponding
+node "active". It will also start sound generation. For this, the graph you
+just build is evaulated at that node and the number stream that results there
+is piped into a PCM device.
+