Skip to content

Commit

Permalink
Update readme and doc
Browse files Browse the repository at this point in the history
  • Loading branch information
sk-zk committed Oct 24, 2024
1 parent e100fa9 commit d6ced40
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 3 deletions.
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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**:
Expand Down
8 changes: 5 additions & 3 deletions docfx/docs/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit d6ced40

Please sign in to comment.