Compare commits

...

4 Commits

Author SHA1 Message Date
Nick Brown 25a138139a
merge of formatting. 2023-08-24 09:31:23 -04:00
Nick Brown 8db885c970
slight update to wording. 2023-08-24 09:28:58 -04:00
Nick Brown c90b0a4953
initial documentation 2023-08-24 09:28:57 -04:00
Nick Brown 7200646261
initial documentation 2023-07-19 17:18:05 -04:00
3 changed files with 53 additions and 0 deletions

20
Makefile Normal file
View File

@ -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

32
README.md Normal file
View File

@ -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`, or `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) (TODO)

1
docs/LANG.md Normal file
View File

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