summaryrefslogtreecommitdiff
path: root/transpile-tests/README.md
diff options
context:
space:
mode:
authorDibyendu Majumdar <mobile@majumdar.org.uk>2023-08-19 08:52:57 -0700
committerDibyendu Majumdar <mobile@majumdar.org.uk>2024-11-26 11:01:47 -0800
commitd63e09a8edf606fea89c6036bc5ae50a331bfd90 (patch)
treeeab060a468268559491719bbec90ec61156abc5c /transpile-tests/README.md
downloadSimple-d63e09a8edf606fea89c6036bc5ae50a331bfd90.tar.gz
Simple-d63e09a8edf606fea89c6036bc5ae50a331bfd90.zip
Chapter 1: Introduction
Co-authored-by: Thalia Archibald <thalia@archibald.dev> Co-authored-by: Cliff Click <cliffc@acm.org> Co-authored-by: XmiliaH <45106915+XmiliaH@users.noreply.github.com>
Diffstat (limited to 'transpile-tests/README.md')
-rw-r--r--transpile-tests/README.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/transpile-tests/README.md b/transpile-tests/README.md
new file mode 100644
index 00000000..aafd3161
--- /dev/null
+++ b/transpile-tests/README.md
@@ -0,0 +1,15 @@
+# Transpile Tests
+
+This module may be helpful if you want to create an implementation of Simple in another language.
+It can parse the JUnit tests to automatically translate most of the boilerplate.
+Some manual tweaks will still be required though, because only common patterns are detected
+(e.g. 01: testSimpleProgram, testZero; 04: testVarArg; 08: testRegress5; 09: testMeet, ...)
+
+## Usage
+
+Just call `JUnitParser.parseRepository` to get a list of parsed test classes for each chapter,
+and implement a pretty printer for your favourite language.
+
+For an example you can refer to `printers.RustPrinter`,
+which produces tests similar to the ones used by
+[Simple-Rust](https://github.com/SeaOfNodes/Simple-Rust).