1  [![Build](https://github.com/42Paris/minilibx-linux/actions/workflows/ci.yml/badge.svg)](https://github.com/42Paris/minilibx-linux/actions/workflows/ci.yml)
 2  
 3  This is the MinilibX, a simple X-Window (X11R6) programming API
 4  in C, designed for students, suitable for X-beginners.
 5  
 6  
 7  Contents
 8  
 9   - source code in C to create the mlx library
10   - man pages (in man/ directory)
11   - a test program (in test/ directory) is built
12     with the library
13   - a public include file mlx.h
14   - a tiny configure script to generate an appropriate Makefile.gen
15  
16  Requirements for Linux
17  
18   - MinilibX only support TrueColor visual type (8,15,16,24 or 32 bits depth)
19   - gcc
20   - make
21   - X11 include files (package xorg)
22   - XShm extension must be present (package libxext-dev)
23   - Utility functions from BSD systems - development files (package libbsd-dev)
24   - **e.g. _sudo apt-get install gcc make xorg libxext-dev libbsd-dev_ (Debian/Ubuntu)**
25   
26  Requirements for MacOS
27   - [Xquartz](https://www.xquartz.org/)
28  
29  ```bash
30  ➜  ~ Brew install Xquartz
31  ➜  ~ reboot
32  ➜  ~ xeyes # run an hello world X11 app
33  ```
34  
35  MlX Color Opacity / Transparency / Alpha (32 bits depth)
36   - 0xFF (fully transparent) or 0x00 (fully opaque)
37  
38  Compile MinilibX
39  
40   - run ./configure or make
41     both will make a few tests, create Makefile.gen
42     and then automatically run make on this generated Makefile.gen .
43     libmlx.a and libmlx_$(HOSTTYPE).a are created.
44     test/mlx-test binary is also created.
45  
46  
47  Install MinilibX
48  
49   - no installation script is provided. You may want to install
50       - libmlx.a and/or libmlx_$(HOSTTYPE).a in /usr/X11/lib or /usr/local/lib
51       - mlx.h in /usr/X11/include or /usr/local/include
52       - man/man3/mlx*.1 in /usr/X11/man/man3 or /usr/local/man/man3
53  
54  
55   Olivier CROUZET - 2014-01-06 -