Readme.md > Internal / Readme.md
This sub-directory of xo-args contains a build system and unit tests for xo-args that aren't as relevant to users of xo-args.
- ✅ clang on Linux: Supported and regularly tested.
- ✅ gcc on Linux: Supported and regularly tested.
- ✅ msvc on Windows: Supported and regularly tested.
- ❔ clang everywhere else: Unknown. Probably supported.
- ❔ gcc everywhere else: Unknown. Probably supported.
- ❔ other compilers and platforms: Unknown. Probably supported.
If you know how to use Premake5 you should be able to get other build systems to work. The above listed support is what's being tested during development of xo-args and is expected to work with scripts in this repository.
Follow the contributor guide for Linux or Windows.
Make sure all projects in the solution build and all tests pass for msvc, clang, and gcc. There's a comprehensive-test.bat script that is intended to make this easier: it builds all projects in every configuration across Windows and Linux (using WSL).
Changes to the code should be followed by running ClangFormat. I recommend using Clang Power Tools for Visual Studio which can be used to invoke ClangFormat.
If you're submitting a pull request make sure to leave a useful description that can help me understand the intention of your changes and any major decisions that went into it.
If you're thinking of making a large change please reach out to discuss it first.