Chapter 1: Introductionlinear-chapter01

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>

1 files changed, 18 insertions, 0 deletions

diff --git a/transpile-tests/README.md b/transpile-tests/README.md
new file mode 100644
index 00000000..0f13756a
--- /dev/null
+++ b/transpile-tests/README.md
@@ -0,0 +1,18 @@
+# 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.
+
+## 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).
+
+Note that although all tests of all chapters are parsed,
+you probably only want to transpile the latest test of each chapter.
+For the rest you can just manually port the small changes between chapters.