Skip to content

Commit

Permalink
Version 0.2.0
Browse files Browse the repository at this point in the history
  • Loading branch information
AsriFox committed Dec 3, 2023
1 parent 40eafb3 commit dbe7a7f
Show file tree
Hide file tree
Showing 8 changed files with 26 additions and 14 deletions.
34 changes: 23 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,35 @@
# GNURadio Integration
![icon](./imgs/gnuradio-integration-icon.png)

An extension to help you manipulate GNURadio Companion files in VSCode. Adds support for "`.grc`" files.

![preview](./imgs/preview.png)
An extension to help you with work with GNURadio in VSCode.
- Context menu actions for opening and compiling "`.grc`" files
- Commands for manipulating the OOT module with `gr_modtool`

## Command palette

- **Open GNURadio Companion** - open GNURadio Companion application.
![Command palette](./imgs/command_palette.png)
- **GNURadio Companion: Open the application**;
- **GNURadio Module**:
- **Create OOT Module**;
- **Create Block**;
- **Create Python Bindings**;
- **Rename Block**;
- **Remove Block**;
- **Convert XML to YAML**.

## Explorer context menu

- **Edit In GNURadio Companion** - edit the selected GRC flowgraph file in GNURadio Companion application;
- **Compile Flowgraph** - compile the selected GRC flowgraph file;
- **Compile and Run Flowgraph** - compile and run the selected GRC flowgraph file.
- [Flowgraph](./imgs/flowgraph.png):
- **Edit In GNURadio Companion** - edit the selected GRC flowgraph file in GNURadio Companion application;
- **Compile Flowgraph** - compile the selected GRC flowgraph file;
- **Compile and Run Flowgraph** - compile and run the selected GRC flowgraph file.
- [Header](./imgs/create_bindings.png):
- **Create Python Bindings** - generate pybind11 code based on the block's C++ header;
- [XML](./imgs/convert_xml.png):
- **Convert XML to YAML** - convert old XML block definitions to YAML.

**Warning!** Compilation will overwite the target file without confirmation!

## Extension settings

- **GNURadio Companion command** (default: `gnuradio-companion`);
- **GNURadio CLI compiler command** (default: `grcc`).
- **GNURadio CLI compiler command** (default: `grcc`);
- **GNURadio modtool command** (default: `gr_modtool`);
- **Check for XML block definitions** (default: disabled).
Binary file added imgs/command_palette.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added imgs/convert_xml.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added imgs/create_bindings.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added imgs/flowgraph.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed imgs/preview.png
Binary file not shown.
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"name": "gnuradio-integration",
"displayName": "GNURadio Integration",
"description": "GNURadio Integration",
"version": "0.1.2",
"version": "0.2.0",
"license": "MIT",
"publisher": "AsriFox",
"engines": {
Expand Down

0 comments on commit dbe7a7f

Please sign in to comment.