Commit: 263c62422c88ad10f294ce6fc37f3e986ecdf46a
Parent: 4027ca938d5d0a2b946a0a8ad1af1eb4dd36f4ea
Author: Randy Palamar
Date: Sun, 27 Apr 2025 20:28:14 -0600
add README and LICENSE
Diffstat:
4 files changed, 31 insertions(+), 0 deletions(-)
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,13 @@
+© 2025 Randy Palamar <randy@rnpnr.xyz>
+
+Permission to use, copy, modify, and distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
diff --git a/README.md b/README.md
@@ -0,0 +1,16 @@
+# elfinspect
+
+work in progress [ELF][] and [DWARF][] binary inspector
+
+## Dependencies
+
+- `C11` Compiler (with support for inline assembly)
+- POSIX Compliant C-Runtime
+
+## Usage
+
+Currently the program only supports reading itself and dumping its
+headers to `stdout`.
+
+[ELF]: https://www.man7.org/linux/man-pages/man5/elf.5.html
+[DWARF]: https://dwarfstd.org/doc/DWARF5.pdf
diff --git a/elfinspect.c b/elfinspect.c
@@ -1,3 +1,4 @@
+/* See LICENSE for license details. */
#define local_persist static
#define global static
#define function static
diff --git a/main_posix.c b/main_posix.c
@@ -1,3 +1,4 @@
+/* See LICENSE for license details. */
#include <stdint.h>
#include <stddef.h>