Skip to content

quickstart.mdx

Latest commit

 

History

History
86 lines (68 loc) · 1.92 KB

quickstart.mdx

File metadata and controls

86 lines (68 loc) · 1.92 KB
title Quickstart
description Install ANcpLua.NET.Sdk in your .NET 10 project.

Prerequisites

[.NET 10 SDK](https://dotnet.microsoft.com/download/dotnet/10.0) installed [Central Package Management](/index#requirements) enabled

Installation

Add to your `global.json` (create if it doesn't exist): 
    ```json title="global.json"
    {
        "msbuild-sdks": {
        "ANcpLua.NET.Sdk": "*"
    }
    }
    ```

</Step>
<Step title="Update project file">
    Set the `Sdk` attribute to the variant you need:

    ```xml title="Library or Console"
    <Project Sdk="ANcpLua.NET.Sdk">
        <PropertyGroup>
            <TargetFramework>net10.0</TargetFramework>
        </PropertyGroup>
    </Project>
    ```

    ```xml title="ASP.NET Core API"
    <Project Sdk="ANcpLua.NET.Sdk.Web">
        <PropertyGroup>
            <TargetFramework>net10.0</TargetFramework>
        </PropertyGroup>
    </Project>
    ```

    ```xml title="xUnit v3 Tests"
    <Project Sdk="ANcpLua.NET.Sdk.Test">
        <PropertyGroup>
            <TargetFramework>net10.0</TargetFramework>
        </PropertyGroup>
    </Project>
    ```

</Step>
<Step title="Build">
    ```bash
    dotnet build
    ```
</Step>

What's configured

After installation, you automatically get:

  • Nullable reference types enabled
  • LangVersion latest
  • Deterministic builds
  • Roslyn analyzers
  • Banned API enforcement

Multi-targeting

To support older frameworks alongside .NET 10:

<Project Sdk="ANcpLua.NET.Sdk">
  <PropertyGroup>
    <TargetFrameworks>net10.0;netstandard2.0</TargetFrameworks>
  </PropertyGroup>
</Project>

Polyfills are auto-injected for netstandard2.0 targets. See Polyfills.