diff options
| author | Juan J. Martinez <jjm@usebox.net> | 2021-04-17 22:05:24 +0100 |
|---|---|---|
| committer | Juan J. Martinez <jjm@usebox.net> | 2021-04-17 22:05:24 +0100 |
| commit | a5745813e442b66ae6eed30bba81d1b3dd5cf634 (patch) | |
| tree | b302db1780350dc44543b81d49bfc1b2d4dff6a8 /sdcc/README.MD | |
| download | beeper-int-zx-a5745813e442b66ae6eed30bba81d1b3dd5cf634.tar.gz beeper-int-zx-a5745813e442b66ae6eed30bba81d1b3dd5cf634.zip | |
Initial public release
Diffstat (limited to 'sdcc/README.MD')
| -rw-r--r-- | sdcc/README.MD | 23 |
1 files changed, 23 insertions, 0 deletions
diff --git a/sdcc/README.MD b/sdcc/README.MD new file mode 100644 index 0000000..7ec00a3 --- /dev/null +++ b/sdcc/README.MD @@ -0,0 +1,23 @@ +This is the main implementation of the beeper engine, to be used with SDCC +compiler. + +The assembler syntax specific to this compiler suite, but it should be +easy to convert to your favourite assembler. + +Feel free to contribute your port! + +## Build instructions + +Ensure that SDCC is in your path and run `make`. + +Include this directory in your include and library paths, and link with the +beeper library. + +For example: +``` +CFLAGS += -I$(BEEPER_LIB_DIR) +LDFLAGS += -L$(BEEPER_LIB_DIR) -lbeeper +``` + +It is recommended that the beeper code runs from non-contended memory. + |