Skip to content

Commit acb8918

Browse files
committed
README: Added overview and a dependency
1 parent 8dee3b3 commit acb8918

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,18 @@
22
------------------------------
33

44
## Overview
5-
The module provides various sinks and widgets to allow interaction with the live simulation remotely over the network. The module was developed as a part of Google Summer of Code 2017.
5+
The module provides various sinks and widgets to allow interaction with the live GNU Radio applications remotely over the network. The module uses [Bokeh](https://bokeh.pydata.org/en/latest/)'s client API and streaming features. Using widgets and plots from Bokeh, the module enables the GUI for GNU Radio that renders in web browser. Just like `gr-qtgui`, it is fully integrated with GRC to allow easy use.
6+
7+
The module was developed as a part of Google Summer of Code 2017.
68

79
## Dependency
810
1. GNU Radio (should contain [commit@3c989f9](https://github.com/gnuradio/gnuradio/pull/1434))
911
2. [Bokeh library](https://bokeh.pydata.org/en/latest/)
1012
(Tested on v0.12.06)
1113
3. Tornado v4.4
14+
4. NodeJS v6.6.x - v7.0
1215

13-
## GNU Radio dependency
16+
### GNU Radio dependency
1417
Make sure you use most recent version of GNU Radio. If you are using v3.7.12, please make sure to use commit@3c989f9. It contains necessary changes in core GRC to enable the use of `gr-bokehgui`.
1518

1619
## Installation
@@ -57,7 +60,6 @@ The following Youtube video provides quick glance over the module and basic proc
5760

5861
### Minor tasks:
5962
1. Enable averaging in Frequency sink
60-
2. Change Waterfall orientation to top-bottom
6163

6264
## Bugs reporting:
6365
Kindly report any bugs or issues [on Github](https://github.com/kartikp1995/gr-bokehgui/issues/).

0 commit comments

Comments
 (0)