Skip to content

Commit

Permalink
Release 0.4.0
Browse files Browse the repository at this point in the history
  • Loading branch information
AsriFox committed Feb 4, 2024
1 parent ae2477a commit 080287c
Show file tree
Hide file tree
Showing 4 changed files with 14 additions and 9 deletions.
5 changes: 4 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ All notable changes to the "gnuradio-integration" extension will be documented i
Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how to structure this file.

## [Unreleased]

## [0.4.0] - 2024-02-04
### Added
- Added schema for `.block.yml`, `.tree.yml` and `.grc` file validation
- Added integration with `redhat.vscode-yaml` extension (enables schemas automatically)
Expand Down Expand Up @@ -158,7 +160,8 @@ a workaround to activate the extension when the module has no blocks yet
### Added
- This is the initial release of gnuradio-integration VS Code extension

[Unreleased]: https://github.com/AsriFox/gnuradio-integration/compare/v0.3.4...HEAD
[Unreleased]: https://github.com/AsriFox/gnuradio-integration/compare/v0.4.0...HEAD
[0.4.0]: https://github.com/AsriFox/gnuradio-integration/compare/v0.4.0...v0.3.4
[0.3.4]: https://github.com/AsriFox/gnuradio-integration/compare/v0.3.3...v0.3.4
[0.3.3]: https://github.com/AsriFox/gnuradio-integration/compare/v0.3.2...v0.3.3
[0.3.2]: https://github.com/AsriFox/gnuradio-integration/compare/v0.3.1...v0.3.2
Expand Down
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# GNURadio Integration
![icon](./imgs/gnuradio-integration-icon.png)

An extension to help you with work with [GNURadio](https://www.gnuradio.org) in VSCode.

Features:
- Opening and compiling GRC Flowgraph files (`.grc`)
- Browsing the OOT module to see all blocks and the corresponding files
- Manipulating the OOT module with `gr_modtool`
- Editing GRC Flowgraph (`.grc`) and block definition (`.block.yml`, `.tree.yml`) files with syntax highlighting and validation
- Requires YAML extension (`redhat.vscode-yaml`: [Open VSX Registry](https://open-vsx.org/extension/redhat/vscode-yaml), [VS Marketplace](https://marketplace.visualstudio.com/items?itemName=redhat.vscode-yaml))

## OOT Module Explorer
If a GNURadio OOT module is detected in the workspace, the **GNURadio Module** tree view will appear in the Explorer container. All blocks within that module are presented with the corresponding files: YAML GRC block definition, Python implementation for Python blocks, C++ header and implementation for C++ blocks, Python and C++ QA (unit testing) source files.
Expand Down Expand Up @@ -50,7 +50,7 @@ If a GNURadio OOT module is detected in the workspace, the **GNURadio Module** t
## GNURadio Prefix and Python Environment
If your GNURadio is not installed system-wide (e.g. from `apt`), then it might not be discoverable by the extension. To check if the installation is available, try running `gnuradio-config-info --prefix` in your terminal.

For [Conda-based installations](https://wiki.gnuradio.org/index.php?title=CondaInstall) you can use the VSCode Python extension (`ms-python.python`: [Open VSX Registry](https://open-vsx.org/extension/ms-python/python), [VS marketplace](https://marketplace.visualstudio.com/items?itemName=ms-python.python)) to activate your environment with GNURadio installation in it.
For [Conda-based installations](https://wiki.gnuradio.org/index.php?title=CondaInstall) you can use the VSCode Python extension (`ms-python.python`: [Open VSX Registry](https://open-vsx.org/extension/ms-python/python), [VS Marketplace](https://marketplace.visualstudio.com/items?itemName=ms-python.python)) to activate your environment with GNURadio installation in it.
![Python: Select Interpreter](./imgs/python_interpreters.png)

When building from source on [Linux](https://wiki.gnuradio.org/index.php?title=LinuxInstall#From_Source), [Windows](https://wiki.gnuradio.org/index.php?title=WindowsInstall#Installation_Options) or [Mac OS](https://wiki.gnuradio.org/index.php?title=MacInstall#From_Source), you can select your install location. To make this installation available to the extension, you can set GNURadio Prefix through extension settings using the output of `gnuradio-config-info --prefix`.
Expand All @@ -63,4 +63,5 @@ Please use the output of `gnuradio-config-info --prefix`; see [InstallingGR](htt
- **Python** - for virtual environments:
- **Default interpreter**: path to an executable (e.g. `~/.local/bin/python`);
- **Default PYTHONPATH**: paths to library directories (e.g. `~/.local/lib/python3.11/site-packages`);
- **Check for XML block definitions** on startup (default: disabled).
- **Check for XML block definitions** on startup (default: disabled)
- **Use schema for GRC files verification**
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.

5 changes: 3 additions & 2 deletions 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.3.4",
"version": "0.4.0",
"license": "MIT",
"publisher": "AsriFox",
"engines": {
Expand All @@ -24,7 +24,8 @@
],
"activationEvents": [
"workspaceContains:**/*.grc",
"workspaceContains:**/*.block.yml"
"workspaceContains:**/*.block.yml",
"workspaceContains:**/*.tree.yml"
],
"main": "./out/extension.js",
"contributes": {
Expand Down

0 comments on commit 080287c

Please sign in to comment.