README.modtool
1gr_modtool: Swiss Army Knife for editing GNU Radio modules and -components.
2
3Adding a new subcommand for Command Line Interface
4==================================================
5
6* Add a new file called SUBCOMMAND in the cli directory
7* Create a function cli with the decorator @click.command or @click.group
8* Add the necessary options for the command or command group
9* Add that file to __init__.py and CMakeLists.txt in the cli directory
10
11
12Adding a new subcommand for Exposing as an API
13==============================================
14
15* Add a new file called SUBCOMMAND in the core directory
16* Have a look at the other subcommands, it must inherit from ModTool
17* Add that file to __init__.py and CMakeLists.txt in the core directory
18
19
20The gr-newmod directory inside the templates directory
21======================================================
22
23This dir basically contains a copy of gr-howto-write-a-block from the gnuradio
24sources, with some differences:
25- All example blocks, apps, grc files (...) and references thereto in the
26 CMake files are removed
27- In the top-level CMake file, the project is called 'gr-howto'.
28- Any time anything relevant is changed in gr-howto-write-a-block, it should
29 be changed here, too.
30