Initial commit

docs/INSTALL.md

@@ -0,0 +1,89 @@
+
+Aya Installation
+================
+
+    0. Preface
+    1. Supported platforms
+       1.1. Compilers
+       1.2. Platform-specific notes
+            1.2.1. Windows
+            1.2.2. Linux
+            1.2.3. Xbox, Mac, and iOS
+       1.3. Adding support for new platforms
+    2. configure options
+    3. Internal tools
+    4. Tests
+    5. Troubleshooting
+
+
+0. Preface
+----------
+
+    Aya was created with the intention of being as easy to set up and use as
+    possible, using industry-standard tooling commonplace in software
+    engineering. That said, Aya does not attempt to hold your hand in doing
+    so and leaves much of the customization up to the end user for maximum
+    versatility.
+
+    This guide was written based upon the assumption that the end-user has a
+    grasp on how to use tools such as CMake, Clang, Python, as well as posessing
+    a general knowledge on how to use C++.
+
+
+1. Supported platforms
+----------------------
+
+    TODO
+
+
+
+1.1. Compilers
+
+    TODO
+
+
+1.2. Platform-specific notes
+
+1.2.1. Windows
+
+    TODO
+
+
+1.2.2. Linux
+
+    TODO
+
+
+1.2.3. Xbox, Mac, and iOS
+
+    TODO
+
+
+1.3. Adding support for new platforms
+
+    TODO
+
+
+2. configure options
+--------------------
+
+    TODO
+
+
+3. Internal tools
+-----------------
+
+    TODO
+
+
+4. Tests
+--------
+
+    TODO
+
+
+5. Troubleshooting
+------------------
+
+    TODO
+