Skip to content

getting-started.md

Latest commit

 

History

History
72 lines (53 loc) · 2.8 KB

getting-started.md

File metadata and controls

72 lines (53 loc) · 2.8 KB
Raw

Getting Started

Installation, configuration, and a first containerized build with the Container Extension for OneWare Studio.

Prerequisites

Installation

From Source

# Clone the repository
git clone --recurse-submodules https://github.com/FEntwumS/FEntwumS.ContainerExtension.git
cd FEntwumS.ContainerExtension

# Build the plugin
dotnet build -c Release

# Deploy to OneWare Studio
cp -r src/ContainerExtension/bin/Release/net10.0/* \
  ~/OneWareStudio/Packages/Plugins/ContainerExtension/

From OneWare Package Manager

  1. Open OneWare Studio and go to the Extension Manager.
  2. Search for Container Extension and click Install.
  3. Restart OneWare Studio to load the extension.

First Run

  1. Launch OneWare Studio - The plugin loads automatically
  2. Health Check - On startup, the extension verifies Docker daemon connectivity in the background
  3. Open the Dashboard - Choose View > Tool Windows > Container Dashboard (or run the Container Dashboard command). It opens as a right-pinned dockable panel with a whale icon
  4. Verify Connection - The dashboard shows daemon health, Docker version, and OS info

Your First Containerized Build

  1. Open an FPGA project in OneWare Studio (e.g., a VHDL project)
  2. In any tool's settings, switch the Execution Strategy from NativeExecutionStrategy to DockerExecutionStrategy (OneWare lists the raw strategy keys)
  3. Run the tool (e.g., GHDL Analyze) - the extension will:
    • Pull the required image if not cached locally
    • Mount your project directory into the container
    • Execute the tool inside the container
    • Stream output back to the IDE
  4. View execution details in the Container Dashboard's Execution History section

Dashboard Features

The Container Dashboard provides:

Section Description
Quick Actions One-click pull, prune, and hello-world test buttons
Connection Status Daemon health, Docker version, OS, CPU/RAM info
Containers Live container list with stop/remove/view-logs buttons
Images & Disk Cached images with sizes, reclaimable space indicator
Configuration Snapshot of all active Container Engine settings
Execution History Up to 50 telemetry entries with timing and exit codes

Next Steps