Initial commit.

1 files changed, 25 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..e07bb93
--- /dev/null
+++ b/README.md
@@ -0,0 +1,25 @@
+# minias
+
+An assembler for elf x86_64, written for fun and learning.
+
+Goals:
+
+- Assemble the output of [cproc](https://github.com/michaelforney/cproc)/[qbe](https://c9x.me/compile/).
+- x86_64 elf output.
+- Static linking.
+- A simple, tiny, fast implementation (in that order).
+
+Stretch goals:
+
+- Assemble what is needed to compile musl libc.
+- Dynamic linking.
+
+Non Goals:
+
+- Assemble every assembly instruction.
+- Work as a library.
+
+# Resources
+
+- [goas](https://github.com/DQNEO/goas)
+- [neatas](https://repo.or.cz/neatas.git)
\ No newline at end of file