-
Notifications
You must be signed in to change notification settings - Fork 16
Home
Welcome to the axpbox wiki!
Here are a few guidelines when contributing code.
The program from which AXPbox forked, es40 aimed to support a wide range of operating systems, including Windows and OpenVMS. It was developed around 2007/2008, which is reflected in the coding style.
AXPbox currently aims to target Unix-like systems in general (which are targeted by POCO POSIX support), but in the future this might change to either Qt Core 5 or pure C++11 (the second one would be preferred if its features prove to be sufficient).
Note: this specifies platforms AXPbox aims to support, not the ones which are known to work, for those see Host support.
- Language standard: C++11 (for compatibility with platforms that lack modern compilers, please don't pull in C++17/20 or libraries like boost if not needed).
- Compilers:
- GCC
- Clang
- MSVC
- Operating systems (with above compilers)
- Windows
- Linux
- OS X
- BSD
C++ functions are preferred over C style functions when contributing. (e.g. std:cerr
instead of fprintf
and ifstream
instead of FILE*
). This is in contrast with the code style of es40, which is written basically in "C with classes".
- If you want to pull in the current master branch in your working branch, please rebase for the sake of keeping the commit history clean. Here is an article explaining how to rebase vs merge
- Pull requests will most often be merged in main.
There is a clang-format
file in the project, please use that.