summaryrefslogtreecommitdiff
path: root/README.rst
diff options
context:
space:
mode:
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst14
1 files changed, 14 insertions, 0 deletions
diff --git a/README.rst b/README.rst
new file mode 100644
index 0000000..f638ee6
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,14 @@
+linkermapviz
+============
+
+Interactive visualization of GNU ld’s linker map with a tree map. Usage:
+
+.. code:: bash
+
+ pip install .
+ gcc -Wl,-Map,output.map -o output input.c
+ linkermapviz < output.map
+
+Works best with ``-ffunction-sections -fdata-sections`` and statically linked
+code (e.g. for bare-metal embedded systems).
+