From 26b7c09ff3598467d4de83f5c58da4b1a004651d Mon Sep 17 00:00:00 2001
From: Josh Ashton <55456786+quaxlyqueen@users.noreply.github.com>
Date: Wed, 20 Mar 2024 22:31:13 -0600
Subject: [PATCH] Create README.md

---
 README.md | 45 +++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 45 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..771117a
--- /dev/null
+++ b/README.md
@@ -0,0 +1,45 @@
+<h1>Sudoku</h1>
+<p>A project worked on by Programming Club members at Salt Lake Community College.</p>
+<h2>Features</h2>
+<ul>
+  <li><s>Sudoku auto-solver</s></li><br>
+  <li>GUI:</li>
+    <ul>
+      <li>Navigation Bar (<a href="https://lucid.app/lucidchart/238344ab-de24-4be6-972a-70966379df86/edit?viewport_loc=-11%2C-11%2C2155%2C1156%2C0_0&invitationId=inv_870d3842-5217-4c56-a3e5-8fbb5f490c10">UML</a>):</li>
+        <ul>
+          <li>File dropdown for New, Open, and Save</li>
+          <li>Display elapsed time</li>
+          <li>Toggle between Note & Enter modes</li>
+          <li>Display hints</li>
+          <li>Open settings</li>
+        </ul>
+      <li>Sudoku Board:</li>
+      <ul>
+        <li>Differentiated initial values, likely by color</li>
+        <li>Highlight row, column, and box of a selected cell</li>
+        <li>Display noted values in cell's internal grid</li>
+      </ul>
+      <li>Number input</li>
+      <ul>
+        <li>Keyboard bindings & Vim-mode</li>
+        <li>Number pad on the side</li>
+      </ul>
+    </ul><br>
+    
+  <li>File I/O:</li>
+    <ul>
+      <li>.sdku file standard</li>
+        <ul>
+          <li>Current values in cells</li>
+          <li>User "note" values in cells</li>
+          <li>Time spent on the puzzle</li>
+          <li>Number of mistakes</li>
+          <li>Puzzle solution</li>
+        </ul>
+      <li>.sdku file import</li>
+      <li>.sdku file export/saving</li>
+      <li>auto-saving</li>
+    </ul><br>
+  
+  <li>Random .sdku generation</li>
+</ul>