aboutsummaryrefslogtreecommitdiff
path: root/USAGE.md
blob: 706b9c32df98ef7fb427b8c0faf22aba069cba62 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
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
```