From 8adf49a702bfc102066f65048478c65ea26e117b Mon Sep 17 00:00:00 2001
From: wirelyre <wirelyre@gmail.com>
Date: Sun, 7 Nov 2021 22:33:05 -0500
Subject: [PATCH] Update README

---
 README.md | 23 +++++++++++++++++------
 1 file changed, 17 insertions(+), 6 deletions(-)

diff --git a/README.md b/README.md
index 6112162..53de386 100644
--- a/README.md
+++ b/README.md
@@ -1,9 +1,20 @@
-# perfect-clear
+# Tetra tools
 
-A tool for researching 5- and 10-piece perfect clears in tetromino stackers.
+Tools and code libraries for tetromino stackers.
 
-When you run the program, it will do a large precomputation of all possible
-boards which result in 10-piece perfect clears.  These will be saved to a file.
+## Tools
+- `gomen`: very basic web interface for perfect clear solutions
+- `precompute`: compute all possible 10-piece perfect clears
 
-Currently there is no interface at all, but the `gameplay` module implements
-SRS with no library dependencies, which might be useful.
\ No newline at end of file
+## Libraries
+
+- `basic`: 4-line bitboards, implementing SRS
+- `solver`: perfect clears using precomputed boards
+
+#### Why "gomen"?
+
+- fumen = 譜面 = ふめん = 2めん
+- 2めん + 3 = 5めん
+- 5めん = ごめん = gomen
+
+Sorry.  It's a terrible pun.  Hopefully I come up with another name.
\ No newline at end of file