From d6ced40b86babf311ede7c05c9a2e07c42f1a14f Mon Sep 17 00:00:00 2001 From: sk-zk Date: Thu, 24 Oct 2024 16:10:15 +0200 Subject: [PATCH] Update readme and doc --- README.md | 5 +++++ docfx/docs/introduction.md | 8 +++++--- 2 files changed, 10 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 3f68147..b109374 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,11 @@ The currently supported [map format version](https://github.com/sk-zk/map-docs/w (This project is pretty much a perpetual alpha, so you'll probably run into a few issues sooner or later, and breaking changes will happen on occasion.) +## Install +``` +dotnet add package TruckLib +``` + ## Namespaces ### TruckLib **TruckLib.ScsMap**: diff --git a/docfx/docs/introduction.md b/docfx/docs/introduction.md index 9f86db5..b36a9ab 100644 --- a/docfx/docs/introduction.md +++ b/docfx/docs/introduction.md @@ -2,12 +2,14 @@ This is the documentation for [**TruckLib**](https://github.com/sk-zk/TruckLib), a library for the map format of Euro Truck Simulator 2 and American Truck Simulator. +## Install +``` +dotnet add package TruckLib +``` + ## Getting started To get started with the library, check out the [Creating and modifying maps](~/docs/TruckLib.ScsMap/map-class.md) section and the sample code. -There are no builds or NuGet packages at this time, so you will need to clone the repo, add the project(s) to your solution, -and add them as project dependency to your project. - ## Supported formats ### Map