Add LICENSE and enhance README with professional formatting, badges, and comprehensive documentation

maxwell-hauser · maxwell-hauser · commit 364a864e406e · 2025-11-23T23:32:50.000-05:00
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Maxwell Hauser
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/README.md b/README.md
@@ -1,61 +1,132 @@
-# 2D Array Operations (Java GUI)
+# 2D Array Operations
 
-A lightweight Java AWT/Swing desktop app to create and explore two‑dimensional integer arrays. It provides interactive menus to generate arrays, compute statistics, search values, and perform matrix operations with a visual grid display.
+![Java](https://img.shields.io/badge/Java-21-ED8B00?style=flat&logo=openjdk&logoColor=white)
+![Maven](https://img.shields.io/badge/Maven-3.9+-C71A36?style=flat&logo=apache-maven)
+![License](https://img.shields.io/badge/License-MIT-blue?style=flat)
+![Status](https://img.shields.io/badge/Status-Active-success?style=flat)
 
-## Features
-- Create a random 2D array with custom rows/cols and value range
-- Statistics: minimum, maximum, average, standard deviation
-- Operations: search for a value, add, subtract, and multiply arrays
-- Visual output: draws arrays in a grid with labels and results
-- Resizable window; redraws on resize
+A Java AWT/Swing desktop application for creating, visualizing, and manipulating two-dimensional integer arrays with comprehensive statistical analysis and matrix operations.
 
-## How It Works
-- UI shell: `Array2DOperations` (Frame with menus, drawing surface)
-- Core logic: `TwoDArray` (array creation, stats, search, math)
-- Rendering: values and outlines drawn using `Graphics`
-- Input: dialogs (`JOptionPane`) prompt for sizes, ranges, and search keys
+## ✨ Features
 
-## Requirements
-- JDK 8+ (AWT/Swing included)
-- Windows/macOS/Linux
+- **Array Generation**: Create random 2D arrays with custom dimensions and value ranges
+- **Visual Display**: Interactive grid rendering with automatic resize support
+- **Statistical Analysis**: Calculate min, max, average, and standard deviation
+- **Search Operations**: Find values and display their coordinates
+- **Matrix Mathematics**: Add, subtract, and multiply arrays
+- **Menu-Driven Interface**: Intuitive menu system for all operations
+- **Real-Time Updates**: Automatic repainting on window resize
+
+## 🚀 Quick Start
+
+### Using Maven (Recommended)
 
-## Quick Start (Windows PowerShell)
 ```powershell
-cd "g:\My Drive\GITHUB\java\java_array_2d_operations_gh"
+# Build the project
+mvn clean package
+
+# Run the application
+java -jar target/array-2d-operations-1.0.0.jar
+```
+
+### Without Maven
 
+```powershell
 # Compile
 javac Array2DOperations.java TwoDArray.java
 
-# Run (opens a desktop window)
+# Run
 java Array2DOperations
 ```
 
-## Usage Guide
-- File → About: Shows a summary of features
-- Two Dimensional Array → Create New Array: Configure rows, columns, and value range, then generate
-- Statistics → (Min/Max/Avg/Std Dev): Computes and displays results below the grid
-- Operations → Array Search: Prompts for a key and shows location if found
-- Operations → Array Add/Subtract: Prompts for a second array and displays result
-- Operations → Array Multiply: Prompts for a second array and displays `A × B`
-
-Notes:
-- Matrix multiply requires compatible sizes: `A[rows × k] × B[k × cols]`
-- Values are integers; average and standard deviation are rounded for display
-
-## Project Structure
-- `Array2DOperations.java`: Window, menus, event handling, painting
-- `TwoDArray.java`: Creation, statistics, search, add/subtract/multiply helpers
-
-## Common Questions
-- Window doesn’t update after resize? The app listens to resize events and repaints automatically.
-- Where are inputs entered? Via dialogs (rows, columns, low/high values, search keys).
-- Why is multiply disabled sometimes? If dimensions are incompatible, an error is thrown to prevent invalid math.
-
-## Next Steps
-- Add input validation loops (reject invalid/empty values)
-- Export arrays/results to CSV
-- Color-code cells by magnitude or highlight search hits
-- Keyboard shortcuts for frequent actions
-
-## License
-This example is provided as-is for educational and demonstration purposes.
+## 📖 Usage Guide
+
+### Menu Options
+
+#### File Menu
+- **About**: Display feature summary and application info
+
+#### Two Dimensional Array Menu
+- **Create New Array**: Configure rows, columns, and value range to generate random array
+
+#### Statistics Menu
+- **Minimum**: Find and display smallest value
+- **Maximum**: Find and display largest value
+- **Average**: Calculate mean value
+- **Standard Deviation**: Compute statistical deviation
+
+#### Operations Menu
+- **Array Search**: Find specific value and show its location
+- **Array Add**: Add two arrays element-wise
+- **Array Subtract**: Subtract second array from first
+- **Array Multiply**: Perform matrix multiplication (requires compatible dimensions)
+
+## 🔢 Matrix Operations
+
+### Addition & Subtraction
+- Arrays must have same dimensions
+- Element-wise operations
+
+### Multiplication
+- Requires compatible sizes: `A[m × k] × B[k × n] = C[m × n]`
+- Standard matrix multiplication algorithm
+
+## 🏗️ Architecture
+
+### Components
+- **Array2DOperations.java**: Main window, menu system, event handling, rendering
+- **TwoDArray.java**: Core logic for array operations, statistics, and matrix math
+
+### Key Features
+- Dialog-based input using `JOptionPane`
+- Custom rendering with Java Graphics API
+- Event-driven architecture
+- Thread-safe operations
+
+## 📋 Requirements
+
+- **JDK 21** (Temurin recommended)
+- **Maven 3.9+**
+- Cross-platform: Windows, macOS, Linux
+
+## 🏗️ Building from Source
+
+```powershell
+# Clone the repository
+git clone https://github.com/maxwell-hauser/java_array_2d_operations.git
+cd java_array_2d_operations
+
+# Build with Maven
+mvn clean install
+
+# Run tests
+mvn test
+```
+
+## 💡 Tips
+
+- **Dimensions**: Choose array sizes that fit comfortably in your window
+- **Value Range**: Select appropriate min/max values for better visualization
+- **Matrix Multiplication**: Ensure middle dimensions match (k in A[m×k] and B[k×n])
+- **Resize**: Window automatically redraws arrays when resized
+
+## 🚀 Future Enhancements
+
+- Enhanced input validation with retry loops
+- Export arrays and results to CSV
+- Color-coded cells based on value magnitude
+- Search result highlighting in grid
+- Keyboard shortcuts for frequent operations
+- Additional statistical measures (median, mode)
+
+## 📄 License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+## 👤 Author
+
+**Maxwell Hauser**
+
+## 🤝 Contributing
+
+Contributions, issues, and feature requests are welcome! Feel free to check the [issues page](https://github.com/maxwell-hauser/java_array_2d_operations/issues).
