Update documentation.

Author: Alexandre Marquet

README.md

@@ -9,13 +9,14 @@ A Fast Maximum-Likelihood Decoder for Convolutional Codes. Vehicular Technology
 This implementation provides a significant speedup at moderate SNRs, but is slower
 at low SNR.
 * Viterbi: implements the classical Viterbi algorithm.
-This implementation, which is faster than the one present in gr-trellis, is
-better-suited than Lazy Viterbi for low SNRs.
+This implementation is better-suited than Lazy Viterbi for low SNRs.
 * Dynamic Viterbi: Switch between the two implementations mentionned above,
 depending on SNR.
 
 
-One GRC example is provided in the examples/ directory.
+One GRC example is provided in the examples/ directory:
+* `simple.grc` simple example showing how each decoder should be use in a typical flowgraph. You will have to populate the variable `base_dir`, and put the full path to the source folder of `gr-lazyviterbi` (for example: `/usr/local/src/gr-lazyviterbi`).
+
 There are also two python scripts :
 * `ber_vs_ebn0_75_awgn.py` lets you compare the BER of this algorithm
 and the gr-trellis's implementation of the classical Viterbi algorithm for a

examples/simple.grc

@@ -41,19 +41,7 @@ blocks:
     bus_sink: false
     bus_source: false
     bus_structure: null
-    coordinate: [192, 12]
-    rotation: 0
-    state: disabled
-- name: base_dir
-  id: variable
-  parameters:
-    comment: ''
-    value: '"/home/amarquet/Documents/sdr/gr-lazyviterbi"'
-  states:
-    bus_sink: false
-    bus_source: false
-    bus_structure: null
-    coordinate: [360, 184.0]
+    coordinate: [488, 92.0]
     rotation: 0
     state: enabled
 - name: fsm
@@ -65,7 +53,7 @@ blocks:
     bus_sink: false
     bus_source: false
     bus_structure: null
-    coordinate: [392, 12]
+    coordinate: [192, 12.0]
     rotation: 0
     state: enabled
 - name: noise_amp
@@ -86,7 +74,7 @@ blocks:
     bus_sink: false
     bus_source: false
     bus_structure: null
-    coordinate: [192, 76]
+    coordinate: [192, 76.0]
     rotation: 0
     state: enabled
 - name: samp_rate
@@ -426,7 +414,6 @@ blocks:
     init_state: '0'
     maxoutbuf: '0'
     minoutbuf: '0'
-    thres: '15.0'
   states:
     bus_sink: false
     bus_source: false
@@ -446,14 +433,26 @@ blocks:
     init_state: '0'
     maxoutbuf: '0'
     minoutbuf: '0'
-    thres: '15.0'
   states:
     bus_sink: false
     bus_source: false
     bus_structure: null
     coordinate: [288, 632]
     rotation: 0
     state: enabled
+- name: note_0
+  id: note
+  parameters:
+    alias: ''
+    comment: ''
+    note: Change this!
+  states:
+    bus_sink: false
+    bus_source: false
+    bus_structure: null
+    coordinate: [520, 52.0]
+    rotation: 0
+    state: true
 - name: qtgui_number_sink_0
   id: qtgui_number_sink
   parameters: