initial commit

1 files changed, 40 insertions, 0 deletions

diff --git a/README b/README
new file mode 100644
index 0000000..0ed22db
--- /dev/null
+++ b/README
@@ -0,0 +1,40 @@
+Dependencies
+============
+
+make
+sdcc
+libusb-dev (for stm8flash)
+
+
+Build
+=====
+
+Getting the source via GIT:
+---------------------------
+
+git clone git://git.spreadspace.org/stm8-utils.git
+cd stm8-utils
+make -C contrib
+
+build and flash blink example
+-----------------------------
+
+# cd blink
+adapt Makefile (set BOARD_TYPE)
+# make program
+
+
+Some Hints
+==========
+
+The object files for builded libs will be called lib-<name>.o so make sure
+not to use files named like this for your own code. i.e. if you want
+to use the `led` library it's not possible to have a source file name
+lib-led.c inside your project.
+
+
+License
+=======
+
+The spreadspace STM8 utils are licensed under GPLv3. You can find the
+full text of the license in the file LICENSE.