diff --git a/README.md b/README.md index a93a045..fec781a 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,17 @@ # Sources for compiling a lib devoted to use Serial port 3-pins of CG10/20/50 +% giteapc install Slyvtt/libSerial + +to get the library, and then just #include and -lserial to use it. + just run `make` in the root directory of the project. it will produce the library `libserial.a` -installation into the right compiler folder is not automatic. - So you need to copy `libserial.a` in the lib folder of sh-elf-gcc compiler and the file `include/serial.h` into the include directory +`make install` will install the lib and the header files in the right directories. + `make clean` cleans all the `.o` and the library from the sources folders. - - - +In order to use the lib, then just #include and -lserial to use it.