tests: varlocs workaround format-overflow errors

[platform/upstream/elfutils.git] / README

diff --git a/README b/README
index 33cac74..0e15bae 100644 (file)
--- a/README
+++ b/README
@@ -1,12 +1,31 @@
-Fundamental design decision:
-
-- the sizes of external and internal types are assumed to be the same.
-  This leaves byte ordering aside.  While assuming this the code can be
-  greatly simplified and speed increases.  Since no change violating this
-  assumption is in sight this is believed to be a worthwhile optimization.
-
-- the ABI of the backend modules is not guaranteed.  Really, not guarantee
-  whatsoever.  We are enforcing this in the code.  The modules and their
-  users must match.  No third-party EBL module are supported or allowed.
-  The only reason there are separate modules is to not have the code for
-  all architectures in all the binaries.
+The elfutils project provides libraries and tools for ELF files and DWARF data.
+
+The project home is http://elfutils.org/
+
+Releases are published at ftp://sourceware.org/pub/elfutils/
+Which can also be found at https://sourceware.org/elfutils/ftp/
+
+To build a release do: ./configure && make && make check
+Please check the configure summary to make sure all recommended
+features are enabled. There should be no failures after make check.
+
+Please reports bugs at https://sourceware.org/bugzilla/
+
+The current elfutils source code can be checked out with
+git clone git://sourceware.org/git/elfutils.git
+
+To build a git checkout do:
+  autoreconf -i -f && \
+  ./configure --enable-maintainer-mode && \
+  make && make check
+
+The developer mailinglist to send patches to is
+elfutils-devel@sourceware.org.
+https://sourceware.org/ml/elfutils-devel/
+
+To subscribe send an email to elfutils-devel-subscribe@sourceware.org
+Or use the form at https://sourceware.org/lists.html#ml-requestor
+
+See the CONTRIBUTING file for how to propose patches to the code.
+
+See the NOTES files for some design decisions and notes.