Skip to content

Commit 87f0f31

Browse files
committed
chore(docs): add LICENSE and README
1 parent d7172e3 commit 87f0f31

4 files changed

Lines changed: 51 additions & 18 deletions

File tree

LICENSE

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# The MIT license
2+
**Copyright © 2023 GothicKit Contributors**
3+
4+
Permission is hereby granted, free of charge, to any person obtaining a copy of
5+
this software and associated documentation files (the “Software”), to deal in
6+
the Software without restriction, including without limitation the rights to use,
7+
copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the
8+
Software, and to permit persons to whom the Software is furnished to do so, subject
9+
to the following conditions:
10+
11+
The above copyright notice and this permission notice shall be included in all
12+
copies or substantial portions of the Software.
13+
14+
_THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
15+
INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
16+
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
17+
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
18+
OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
19+
DEALINGS IN THE SOFTWARE._

README.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# _ZenKitCS_
2+
3+
[![Build](https://img.shields.io/github/actions/workflow/status/GothicKit/ZenKitCS/build.yml?label=Build&branch=main)](https://img.shields.io/github/actions/workflow/status/GothicKit/phoenix-shared-interface/build.yml)
4+
![License](https://img.shields.io/github/license/GothicKit/ZenKitCS?label=License&color=important)
5+
![C++](https://img.shields.io/static/v1?label=C%2B%2B&message=17&color=informational)
6+
![Platforms](https://img.shields.io/static/v1?label=Supports&message=GCC%20|%20MinGW-w64%20|%20Clang%20|%20MSVC%20|%20Apple%20Clang&color=blueviolet)
7+
![Version](https://img.shields.io/github/v/tag/GothicKit/ZenKitCS?label=Version&sort=semver)
8+
9+
A C#-library wrapping the [ZenKit](https://github.com/GothicKit/ZenKit) library for parsing game assets of
10+
[PiranhaBytes'](https://www.piranha-bytes.com/) early 2000's games [Gothic](https://en.wikipedia.org/wiki/Gothic_(video_game))
11+
and [Gothic II](https://en.wikipedia.org/wiki/Gothic_II).
12+
13+
## Building
14+
15+
You will need:
16+
17+
* .NET Standard 2.1 (for `ZenKit` itself) and .NET 7 (for `ZenKit.Tests`), anything onward should work as well
18+
* Git
19+
20+
To build _ZenKitCS_ from scratch, just open a terminal in a directory of your choice and run
21+
22+
```bash
23+
git clone --recursive https://github.com/GothicKit/ZenKitCS
24+
cd ZenKitCS
25+
dotnet build
26+
```
27+
28+
You will find the built library in `ZenKit/bin/Debug/netstandard2.1`.
29+
30+
## Testing
31+
32+
To test _ZenKitCS_, just run `dotnet test` in the Git folder or in the `ZenKit.Test` project.

ZenKitCS.sln

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,6 @@ Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "ZenKit", "ZenKit\ZenKit.csp
44
EndProject
55
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "ZenKit.Test", "ZenKit.Test\ZenKit.Test.csproj", "{21900B0F-7454-46DB-912C-AA6B94FA333C}"
66
EndProject
7-
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "ZenKitExamples", "ZenKitExamples\ZenKitExamples.csproj", "{C7849268-7E94-4D95-B0FF-9C11C8550EFD}"
8-
EndProject
97
Global
108
GlobalSection(SolutionConfigurationPlatforms) = preSolution
119
Debug|Any CPU = Debug|Any CPU
@@ -20,9 +18,5 @@ Global
2018
{21900B0F-7454-46DB-912C-AA6B94FA333C}.Debug|Any CPU.Build.0 = Debug|Any CPU
2119
{21900B0F-7454-46DB-912C-AA6B94FA333C}.Release|Any CPU.ActiveCfg = Release|Any CPU
2220
{21900B0F-7454-46DB-912C-AA6B94FA333C}.Release|Any CPU.Build.0 = Release|Any CPU
23-
{C7849268-7E94-4D95-B0FF-9C11C8550EFD}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
24-
{C7849268-7E94-4D95-B0FF-9C11C8550EFD}.Debug|Any CPU.Build.0 = Debug|Any CPU
25-
{C7849268-7E94-4D95-B0FF-9C11C8550EFD}.Release|Any CPU.ActiveCfg = Release|Any CPU
26-
{C7849268-7E94-4D95-B0FF-9C11C8550EFD}.Release|Any CPU.Build.0 = Release|Any CPU
2721
EndGlobalSection
2822
EndGlobal

ZenKitCS.sln.DotSettings.user

Lines changed: 0 additions & 12 deletions
This file was deleted.

0 commit comments

Comments
 (0)