Document the new module, related to #148

JetBrains · Apr 20, 2020 · 9b7759e · 9b7759e
1 parent ef15663
commit 9b7759e
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 0 deletions.
diff --git a/ARCHITECTURE.md b/ARCHITECTURE.md
@@ -57,6 +57,7 @@ Arend is split into several subprojects:
 |`api`|open API for writing Arend extensions.|
 |`base`|the Arend typechecker.<br/>It depends on `api`, `proto`.|
 |`cli`|the CLI frontend of Arend with the ANTLR parser.<br/>It depends on `base`, `parser`, `api`, `proto`.|
+|`tester`|Helper for writing unit tests with JUnit4.<br/>It depends on `base`, `parser`, `api`, `cli`.|
 
 The purpose of `parser` is to avoid introducing the dependency of the ANTLR
 generator to other subprojects which only requires

diff --git a/README.md b/README.md
@@ -41,6 +41,8 @@ dependencies {
     implementation "com.github.JetBrains.Arend:proto:$arendVersion"
     // The main compiler
     implementation "com.github.JetBrains.Arend:base:$arendVersion"
+    // The unit test helpers
+    testImplementation "com.github.JetBrains.Arend:tester:$arendVersion"
 }
 ```
 
@@ -58,5 +60,6 @@ dependencies {
     implementation("com.github.JetBrains.Arend:parser:$arendVersion")
     implementation("com.github.JetBrains.Arend:proto:$arendVersion")
     implementation("com.github.JetBrains.Arend:base:$arendVersion")
+    testImplementation("com.github.JetBrains.Arend:tester:$arendVersion")
 }
 ```