Skip to content

Comments

Modernized documentation and removed obsolete files#4

Open
byteshiftlabs wants to merge 2 commits intomainfrom
refactor/modernize-documentation
Open

Modernized documentation and removed obsolete files#4
byteshiftlabs wants to merge 2 commits intomainfrom
refactor/modernize-documentation

Conversation

@byteshiftlabs
Copy link
Owner

Summary

Updated project documentation to modern standards and removed obsolete legacy files that are no longer relevant in 2026.

Changes

Documentation

  • README.md: Replaced plain text README with modern Markdown format

    • Removed outdated contact information (20-year-old postal address, invalid email format)
    • Updated GDB version references (removed mentions of GDB 6.x, now supports 6.x through 14.x)
    • Removed references to obsolete software (RHIDE, SETEdit from 1990s)
    • Modernized build instructions (safer PREFIX defaults, clearer structure)
    • Added proper sections for prerequisites, examples, and contribution guidelines
  • CONTRIBUTING.md: Created comprehensive contribution guide

    • Defined coding standards: max 50-60 line functions, no magic numbers, no uninitialized variables
    • Documented naming conventions with good/bad examples
    • Added commit message format guidelines (past participle)
    • Included code quality principles and error handling requirements

Obsolete Files Removed

  • .cvsignore files (CVS obsolete since ~2005, project uses Git)
  • libmigdb.epr (unknown obsolete IDE project file)
  • DJGPP.why renamed to DJGPP.why.obsolete (DOS-era content preserved for historical reference)

License Updates

  • Updated FSF address in LICENSE and GPL-license (FSF moved in 2005)
  • Updated FSF address in all source file headers
  • No license changes - both GPLv2 license files preserved

Build System

  • Added .gitignore for build artifacts (*.o, *.a, *.so)

Impact

  • No functional code changes
  • Improved developer onboarding with clear documentation
  • Removed confusion from obsolete files
  • Maintained full backward compatibility

Testing

  • Documentation reviewed for accuracy
  • Build system unchanged (only added .gitignore)
  • All license files preserved

- Removed obsolete CVS files (.cvsignore) and libmigdb.epr
- Renamed DJGPP.why to DJGPP.why.obsolete (historical reference)
- Replaced old README with modern README.md (Markdown format)
  * Removed outdated contact info and GDB version references
  * Updated build instructions with safer defaults
  * Added clearer structure and navigation
- Created CONTRIBUTING.md with comprehensive coding standards
  * Defined function size limits, naming conventions
  * Added examples of good/bad practices
  * Documented commit message format
- Updated FSF address in LICENSE and GPL-license (moved 2005)
- Updated FSF address in all source file headers
- Preserved both license files (no license changes)
- Added .gitignore for build artifacts
@byteshiftlabs byteshiftlabs added the documentation Improvements or additions to documentation label Feb 7, 2026
@byteshiftlabs byteshiftlabs self-assigned this Feb 7, 2026
@byteshiftlabs byteshiftlabs added the documentation Improvements or additions to documentation label Feb 7, 2026
- Added Salvador E. Tropea as original creator
- Removed obsolete contact information
- Preserves historical attribution
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant