diff --git a/readme.md b/readme.md index 2ff97a7..31c8803 100644 --- a/readme.md +++ b/readme.md @@ -1,54 +1,3 @@ # _phoenix shared interface_ -[![Build](https://img.shields.io/github/actions/workflow/status/GothicKit/phoenix-shared-interface/build.yml?label=Build&branch=main)](https://img.shields.io/github/actions/workflow/status/GothicKit/phoenix-shared-interface/build.yml) -![License](https://img.shields.io/github/license/GothicKit/phoenix-shared-interface?label=License&color=important) -![C++](https://img.shields.io/static/v1?label=C%2B%2B&message=17&color=informational) -![Platforms](https://img.shields.io/static/v1?label=Supports&message=GCC%20|%20MinGW-w64%20|%20Clang%20|%20MSVC%20|%20Apple%20Clang&color=blueviolet) -![Version](https://img.shields.io/github/v/tag/GothicKit/phoenix-shared-interface?label=Version&sort=semver) - -A C-library wrapping the [phoenix](https://github.com/lmichaelis/phoenix) library for parsing game assets of -[PiranhaBytes'](https://www.piranha-bytes.com/) early 2000's games [Gothic](https://en.wikipedia.org/wiki/Gothic_(video_game)) -and [Gothic II](https://en.wikipedia.org/wiki/Gothic_II). This library is intended to be used as a proxy to _phoenix_ in -cases where C++ can not be used (i.e. when interfacing with another programming language). - -## contributing - -If you'd like to contribute, please read [contributing](contributing.md) first. - -## building - -You will need: - -* A working compiler which supports C++17, like GCC 9 -* CMake 3.10 or above -* Git - -### default -To build _phoenix-shared-interface_ from scratch, just open a terminal in a directory of your choice and run - -```bash -git clone --recursive https://github.com/GothicKit/phoenix-shared-interface -cd phoenix-shared-interface -cmake -B build -DCMAKE_BUILD_TYPE=Release -cmake --build build -``` - -You will find the built library in `build/`. - - -### mingw - -If you want to build with MinGW on Windows, follow these instructions - -**setup** -```sh -choco install mingw -choco install cmake --installargs 'ADD_CMAKE_TO_PATH=User' -``` - -**build** -(tested mingw-w64 version: 12.2.0) -```sh -cmake -G "MinGW Makefiles" -B build -DCMAKE_BUILD_TYPE=Release -cmake --build build -``` +# THIS REPO IS DEPRECATED. SWITCH TO [ZenKitCAPI](https://github.com/GothicKit/ZenKitCAPI)!