summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md10
1 files changed, 8 insertions, 2 deletions
diff --git a/README.md b/README.md
index 381dd32..881669a 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,9 @@
-# AAS
+# eAS
-Compile the manual using `mkdir -p docs/build && pdflatex --output-directory="docs/build" "docs/aas.tex"`.
+eAS - the *Embedded Assembler* - is an open-source cross-assembler for embedded devices using the Arm instruction set architecture.
+
+The assembler is primarily targeted at UNIX systems - however - other platforms may be considered in the future.
+
+For more information, see the manual.
+Compile it using the provided makefile via `make -BCdocs`.
+Rerun as needed.