From 0b266e11bab1ccef2cd5b9e9856d0bee229f639b Mon Sep 17 00:00:00 2001
From: Joel Beckmeyer <joel@thebeckmeyers.xyz>
Date: Sat, 9 Dec 2017 18:07:27 -0500
Subject: [PATCH] add readme

---
 readme.md                        |  7 +++++++
 src/termproject/Termproject.java | 26 --------------------------
 2 files changed, 7 insertions(+), 26 deletions(-)
 create mode 100644 readme.md
 delete mode 100644 src/termproject/Termproject.java

diff --git a/readme.md b/readme.md
new file mode 100644
index 0000000..c9ca671
--- /dev/null
+++ b/readme.md
@@ -0,0 +1,7 @@
+# FORTY-TWO
+This program was developed in several days for a university data structures course to meet the following problem specification:
+
+Develop a Java package which implements an ADT for a (2,4) search tree. This search tree is an example of a more general tree called a multiway search tree.
+In a multiway search tree, an internal node can have more than 2 children. For a (2,4) tree, an internal node can have a minimum of 2 children and a maximum of 4. Also, for an internal node, the amount of key-value pairs, or (k,v) pairs, is n - 1 where n is the number of children of the node. For external nodes, the node has a minimum of 1 and a maximum of 3 (k,v) pairs.
+
+As a search tree, the data will be ordered by the keys. For a node w, we will say that w.data[] refers to an array of (k,v) pairs, while w.children[] refers to an array of pointers to the node's children. Given this convention, we can say that w.data[i] < w.data[i + 1]. If a number is greater than w.data[i] but less than w.data[i + 1], then that piece of data is passed on to the node at w.children[i + 1], where we run the same check again. If, when going through this search, we come to an external node, we do a shifting insert at w.data[i + 1].
diff --git a/src/termproject/Termproject.java b/src/termproject/Termproject.java
deleted file mode 100644
index caeac46..0000000
--- a/src/termproject/Termproject.java
+++ /dev/null
@@ -1,26 +0,0 @@
-/*
- * This class contains JUnit tests to run against the ArrayQueue class.
-@author Joel Beckmeyer
-@version 1.0
-File: Filename.java
-Created: YYYY-MM-DD
-Description: This class contains tests for correct exception handling in 
-several different cases, circular array wrapping, dynamic resizing, correct
-method returns, and correct (expected) queue behavior.
- */
-package termproject;
-
-/**
- *
- * @author joel
- */
-public class Termproject {
-
-	/**
-	 * @param args the command line arguments
-	 */
-	public static void main(String[] args) {
-		// TODO code application logic here
-	}
-	
-}