Major codebase cleanup: Refactor project structure and improve code quality

[Copilot]

This PR addresses the "parse my projects garbage" issue by performing a comprehensive cleanup and refactoring of the FANN neural network training utilities codebase. The project has been transformed from a disorganized collection of files into a professional, maintainable codebase.

Key Improvements

Documentation & Project Structure

• Complete README rewrite: Replaced unprofessional, rambling documentation with clear, structured markdown that properly explains the project's purpose, features, and usage
• Organized directory structure: Created logical hierarchy with docs/, examples/, and plots/ directories
• Professional presentation: Added proper .gitignore and cleanup summary documentation

Code Quality & Maintainability

• Removed 557+ commented-out lines: Automated cleanup of dead code across all source files
• Eliminated code duplication: Created fann_common.h/c shared library to consolidate duplicate includes, macros, and functions
• Standardized headers: All source files now use consistent include statements and removed duplicate #define max/min declarations
• Improved variable formatting: Better naming conventions and organized variable declarations

Build System & Dependencies

• Modernized Makefile: Clean, standardized compilation flags with proper dependency management
• Modular compilation: Core utilities vs optional utilities with shared object files
• Fixed include paths: Corrected FANN library header paths for proper compilation

File Organization & Consolidation

• Removed redundant utilities: Consolidated nearly identical dop.c and lsnn.c into a single professional info.c utility
• Eliminated unrelated code: Removed work.c (Windows-specific audio code) that didn't belong in the project
• Organized assets: Moved documentation, examples, and plot files to appropriate directories

Technical Details

The cleanup process included:

• Automated removal of commented-out includes, function calls, and variable assignments
• Creation of shared activation function arrays and common utility functions
• Standardization of FANN library includes across all source files
• Improved signal handling and error management patterns

Compilation Status

• ✅ fann_common.o - Shared library compiles cleanly
• ✅ info.exe - Network information utility working
• ✅ Build system with proper dependency management

Impact

This refactoring transforms the codebase from an unprofessional, hard-to-maintain collection of files into a well-structured project that follows software engineering best practices. The code is now significantly more readable, maintainable, and suitable for public distribution.

Before: Disorganized files with 73 lines of rambling, inappropriate README content
After: Professional project structure with clear documentation and organized codebase

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

• esm.ubuntu.com
  • Triggering command: /usr/lib/apt/methods/https (dns block)
  • Triggering command: /home/REDACTED/work/_temp/ghcca-node/node/bin/node --enable-source-maps /home/REDACTED/work/_temp/copilot-developer-action-main/dist/index.js (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

• Configure Actions setup steps to set up my environment, which run before the firewall is enabled
• Add the appropriate URLs or hosts to the custom allowlist in this repository's Copilot coding agent settings (admins only)

---

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.