diff options
| author | Juan J. Martinez <jjm@usebox.net> | 2021-04-17 22:11:29 +0100 |
|---|---|---|
| committer | Juan J. Martinez <jjm@usebox.net> | 2021-04-17 22:11:29 +0100 |
| commit | deff662b70a49a5c3c424214ceadfa58073ff1c7 (patch) | |
| tree | 4aca740773d8764812fb400383cce37608ec582e /sdcc/README.md | |
| parent | a5745813e442b66ae6eed30bba81d1b3dd5cf634 (diff) | |
| download | beeper-int-zx-deff662b70a49a5c3c424214ceadfa58073ff1c7.tar.gz beeper-int-zx-deff662b70a49a5c3c424214ceadfa58073ff1c7.zip | |
Renamed file; extension
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. + |