Skip to content

Latest commit

 

History

History
19 lines (11 loc) · 1.44 KB

CONTRIBUTING.md

File metadata and controls

19 lines (11 loc) · 1.44 KB

Contributing

First of all, thank you for considering to contribute to StbiSharp!

In order to contribute to this project, simply fork it, implement your contribution in a feature branch, and then create a pull request. Feature additions, bugfixes, and other kinds of contributions are all warmly welcome. I try to review every pull request promptly.

Building

In order to test your additions, you'll have to build StbiSharp.

StbiSharp consists of two components:

  1. a C++ shared library, libstbi, that wraps stb_image.h and exposes a subset of its API, and
  2. a C# project that is used by consumers of StbiSharp to invoke the C++ shared library.

libstbi has to be built natively for each supported operating system. Currently, the supportes operating systems are Windows, macOS, and Linux. Support for mobile platforms is planned and should be simple to add. Pull requests are welcome!

The C# project only has to be built once, as it runs on .net standard and/or .net core, which both are platform independent.

Rather than explaining in writing how exactly to build libstbi and StbiSharp, I invite you to check our GitHub build-and-publish workflow. It contains the minimal set of instructions to build libstbi via a C++ compiler on Ubuntu, macOS, and Windows, as well as the minimal set of instructions for building the C# wrapper using dotnet.