diff options
Diffstat (limited to 'USAGE.md')
-rw-r--r-- | USAGE.md | 27 |
1 files changed, 27 insertions, 0 deletions
diff --git a/USAGE.md b/USAGE.md new file mode 100644 index 0000000..706b9c3 --- /dev/null +++ b/USAGE.md @@ -0,0 +1,27 @@ +# How to compile and use + +Note: it is early in development and there is no v1! + +It is build in a logic of unity-build, so all you need is to provide to a compiler the include folder and link path. + +So, for compiling you need to run build.bat / build.sh. Dependencies right now are just bash (build script) and gcc. + +It will create include folder and copy all of the headers, create lib folder and put the libs in here. + +# Usage + +- Don't use *_internal.h files, as they are only for implementation and could add fun things as windows.h + +# MSVC + +Here are warnings you should disable: + +``` +/wd4244 +``` + +Also here are defines: + +``` +/D _CRT_SECURE_NO_WARNINGS /D _UNICODE /D UNICODE +``` |