From deff662b70a49a5c3c424214ceadfa58073ff1c7 Mon Sep 17 00:00:00 2001
From: "Juan J. Martinez" <jjm@usebox.net>
Date: Sat, 17 Apr 2021 22:11:29 +0100
Subject: Renamed file; extension

---
 sdcc/README.md | 23 +++++++++++++++++++++++
 1 file changed, 23 insertions(+)
 create mode 100644 sdcc/README.md

(limited to 'sdcc/README.md')

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.
+
-- 
cgit v1.2.3