Clarified README

This commit is contained in:
Thomas Touhey 2016-04-21 23:54:05 +02:00
parent 97e523502d
commit 3bbe89e1b1
2 changed files with 23 additions and 5 deletions

5
README
View File

@ -1,5 +0,0 @@
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.
To use when only built, add in your linker flags :
-L "path/to/this/dir" -lmonochrome

23
README.md Normal file
View File

@ -0,0 +1,23 @@
# MonochromeLib - Static Library 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.
---
## Using
To compile with the library, either :
- add the monochrome.h file to one of your include directories ;
- add the monochrome.h file with your sources and include it with the '#include "monochrome.h"' preprocessor directive ;
- add the include dir to your include path by adding '-I "path/to/dir/include"' to your compiler's flags.
To link with your project, either :
- add the libmonochrome.a to one of your static libraries directories ;
- add this library to your static libraries path by adding '-L "path/to/dir"' to your linker's flags/
In either way, you will have to add '-lmonochrome' to your linker's flags.
An example of using this library will then be :
sh3eb-elf-gcc -c -o obj/main.o src/main.c -I lib/monochrome/include
sh3eb-elf-ld -o myaddin obj/main.o -T addin.ld -L lib/monochrome -lmonochrome