initial documentation

Makefile

@@ -0,0 +1,20 @@
+# mill is the current build system
+BS:=mill
+# add things like `-w` or `-d` here for `make` to use them
+BFLAGS:=
+
+.PHONY: all clean compile check test
+
+all: compile
+
+clean:
+	$(BS) $(BFLAGS) clean
+
+compile:
+	$(BS) $(BFLAGS) astral.catalyst.impl.compile
+
+check:
+	$(BS) $(BFLAGS) astral.catalyst.impl.run
+
+test:
+	$(BS) $(BFLAGS) astral.catalyst.impl.runMain com.astraldb.catalyst.TPCHTest

README.md

@@ -0,0 +1,32 @@
+
+# The ASTral Compiler Compiler
+
+## Project Prerequisites 
+
+*The versions listed are what have been tested and shown to work.*
+
+ - `java` and the JDK version 17.0.7
+ - `scala` version 3.3.0
+ - [`mill`](https://mill-build.com/mill/Intro_to_Mill.html) version 0.11.1
+ 
+You can install Scala and Mill using [Coursier](https://get-coursier.io/docs/cli-installation)
+
+## Quick Guide
+
+To clean the project:  
+`make clean` or `mill clean`
+
+To compile the ASTral Catalyst Optimizer:  
+`make`, `make compile` or `mill astral.catalyst.impl.compile`
+
+To run a basic sanity check on the ASTral Catalyst Optimizer:  
+`make check` or `mill astral.catalyst.impl.run`
+
+To run a subset of the TPCH Benchmark across ASTral, Spark with ASTral's rule set, and Spark:  
+`make test` or `mill astral.catalyst.impl.runMain com.astraldb.catalyst.TPCHTest`
+
+*`-w` can be appended to `mill` in any of the above commands to put `mill` into watch mode for incremental changes*
+
+## Language
+
+- [Specification](docs/LANG.md)

docs/LANG.md

@@ -0,0 +1 @@
+# ASTral Language Specification