libmonochrome/README.md

# libmonochrome - The MonochromeLib static implementation

The monochrome library was made by PierrotLL. This project is only a reorganization of the files to make a static library, instead of having to include the source files in the projects each time.

The original docs have been converted to markdown and are available [in the libmonochrome wiki](http://git.planet-casio.com/cakeisalie5/libmonochrome/wikis/home).

## Building

First, create the Makefile configuration with the `./configure` command. Defaults settings should be enough, but if you want to change the installation directories, see `./configure --help`.

To build the library, simply `make`.

To install the built library, use `make install` (it will use the configuration generated by `./configure`).

If you want to contribute, these Makefile targets might help you :
- `make clean`: clean the object files ;
- `make fclean`: clean the object files and the final library ;
- `make re`: cleans the object files and the final library, then makes the project.

## Using

Once installed, when linking a project, you will need to link with the library by adding the `-lmonochrome` flag.