diff --git a/Makefile b/Makefile index f1497e1..9214aa6 100644 --- a/Makefile +++ b/Makefile @@ -49,5 +49,6 @@ clean: $(Q)$(RM) $(JUNK) $(Q)cd source && $(RM) $(JUNK) $(Q)cd lib && $(RM) $(JUNK) + $(Q)cd example && $(RM) $(JUNK) .PHONY: clean all lib diff --git a/README.md b/README.md index 4b707e3..c921289 100644 --- a/README.md +++ b/README.md @@ -20,7 +20,11 @@ Built-in commands can be overriden in user command array. ## How to use -See main.c for example of how to use the library. +To test it with regular gcc, run the Makefile in the `example` directory. + +The main Makefile builds a library for ARM Cortex M4 (can be easily adjusted for others). + +### Stubs to implement Here's an overview of stubs you have to implement (at the time of writing this readme): diff --git a/example/Makefile b/example/Makefile new file mode 100644 index 0000000..9eb068d --- /dev/null +++ b/example/Makefile @@ -0,0 +1,30 @@ +SRC = example.c +SRC += ../source/scpi_parser.c +SRC += ../source/scpi_regs.c +SRC += ../source/scpi_builtins.c +SRC += ../source/scpi_errors.c + +INCL_DIR = ../include + +CFLAGS = -std=gnu99 +CFLAGS += -Wall -Wextra -Wshadow +CFLAGS += -Wwrite-strings -Wold-style-definition -Winline +CFLAGS += -Wredundant-decls -Wfloat-equal -Wsign-compare -Wunused-function + +CC = gcc + +%.o: %.c + + +all: example.elf + +example.elf: $(SRC) + $(Q)$(CC) $(CFLAGS) -I$(INCL_DIR) -o example.elf $(SRC) + +run: example.elf + ./example.elf + +clean: + rm -f *.o *.d *.so *.elf *.bin *.hex + cd ../source + rm -f *.o *.d *.so *.elf *.bin *.hex diff --git a/example.c b/example/example.c similarity index 100% rename from example.c rename to example/example.c