aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorXavi92 <XaviDCR92@users.noreply.github.com>2019-10-29 01:50:09 +0100
committerGitHub <noreply@github.com>2019-10-29 01:50:09 +0100
commit858c50339ff503545fbccfd6da45cbc8a937b23c (patch)
tree48b3f8115d9fc405d64f299f0cd1847f925db732
parent6c58ed406a1dfa724bff457530870ad14cb012b5 (diff)
Added README.md with usage instructions
-rw-r--r--README.md25
1 files changed, 25 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..67412a1
--- /dev/null
+++ b/README.md
@@ -0,0 +1,25 @@
+# stm8-binutils-gdb
+## Overview
+This repository implements, via some patches, STM8 support for the GNU binutils package.
+It has been forked from https://stm8-binutils-gdb.sourceforge.io/ in order to add support
+for unused code elimination at link-time via `--gc-sections`. On the other hand, new relocation
+opcodes `hi8()`, `lo8()` and `hh8()` have been implemented for the STM8 port of GNU `as`.
+
+This is meant to be used with a fork of SDCC I created which generates GNU `as`-compatible assembly
+files via the new `--gas`, `--function-sections` and `--data-sections` switches. These changes have not been integrated into SDCC's main branch, so you
+can find them at https://github.com/XaviDCR92/sdcc-gas .
+## Usage
+```
+./patch_binutils.sh
+./configure_binutils.sh
+cd binutils-2.30/
+make
+sudo make install
+```
+## Examples
+You can find a small working code example of the new capabilities provided by this fork at
+https://github.com/XaviDCR92/stm8-dce-example .
+## Thanks
+Thanks to **arehnman**, who created the original package and helped me out **a lot** to get this working.
+Also, thanks to the SDCC developers to their hard work in providing an interesting alternative to
+existing STM8 propietary compilers.