Installation

Prerequisites

Two things must be in place before the first restore:

1. A .NET SDK that can build the target framework you choose (see the table below). The repository itself builds with the .NET 10 SDK.
2. The private TheTechIdea.Beep.* feed. The core package depends on BeepDM model packages (DataManagementModels, Vis.Modules) that are not published on nuget.org at the required versions. Add the feed to your nuget.config (or a local folder feed) before restoring.

<?xml version="1.0" encoding="utf-8"?>
<configuration>
  <packageSources>
    <clear />
    <add key="nuget.org" value="https://api.nuget.org/v3/index.json" />
    <!-- Internal feed hosting TheTechIdea.Beep.* packages -->
    <add key="beep" value="https://nuget.your-company.com/v3/index.json" />
  </packageSources>
</configuration>

Target Frameworks

NuGet Installation

Install the core package to begin; add family or host packages as needed:

dotnet add package Beep.Skia

# A diagram family
dotnet add package Beep.Skia.ETL

# A platform host
dotnet add package Beep.Skia.Winform.Controls

Packages

Every package ships XML documentation for IntelliSense and a package README.

Project Setup

Reference the namespaces you use. A minimal WinForms or console project needs only three:

using Beep.Skia;              // DrawingManager, ConnectionLine, HistoryManager, themes
using Beep.Skia.Components;   // Material controls and utility components
using Beep.Skia.Flowchart;    // ProcessNode, DecisionNode, ...
using SkiaSharp;              // SKCanvas, SKSurface, SKColor

A console or test project that renders offscreen needs no Windows-specific TFM:

<Project Sdk="Microsoft.NET.Sdk">
  <PropertyGroup>
    <TargetFramework>net9.0</TargetFramework>
    <Nullable>enable</Nullable>
    <ImplicitUsings>enable</ImplicitUsings>
  </PropertyGroup>
</Project>

A WinForms app that uses SkiaHostControl targets the Windows TFM the host package provides:

<Project Sdk="Microsoft.NET.Sdk">
  <PropertyGroup>
    <OutputType>WinExe</OutputType>
    <TargetFramework>net10.0-windows10.0.19041.0</TargetFramework>
    <UseWindowsForms>true</UseWindowsForms>
    <Nullable>enable</Nullable>
  </PropertyGroup>
</Project>

Dependencies

The core package resolves these automatically:

Serialization uses System.Text.Json from the framework — no extra package is needed.

Solution Structure

The solution holds 27 projects: the core, the shared model, 16 family libraries, five host adapters, the loader extension, the tests and two runnable samples.

Verifying Installation

Confirm that Beep.Skia is correctly installed by running a minimal render test:

using Beep.Skia;
using Beep.Skia.Flowchart;
using SkiaSharp;

using var surface = SKSurface.Create(new SKImageInfo(800, 600));
var canvas = surface.Canvas;

var manager = new DrawingManager();
manager.AddComponent(new ProcessNode
{
    Label = "Hello Beep.Skia",
    X = 50, Y = 50, Width = 180, Height = 60
});

manager.Draw(canvas);
Console.WriteLine($"Canvas nodes: {manager.GetComponents().Count}");
Console.WriteLine("Beep.Skia installation verified successfully.");

If the code compiles and runs without errors, Beep.Skia is ready for development. For further guidance, proceed to the Quick Start Tutorial, or see Troubleshooting if restore fails.