Improve project documentation with comprehensive guides#117
Merged
Conversation
Add complete DMP file format specification: - Detailed technical specification with byte-by-byte breakdown - Documentation for all format versions (2, 3, 4, 5) - Implementation details for parser development - Data conversion formulas and validation rules - Binary data examples with annotations - Error handling and troubleshooting guidance Enhance contribution guidelines: - Clear project structure and architecture explanation - Comprehensive coding standards and style guide - Detailed development workflow and branch strategy - GitHub Actions CI/CD pipeline documentation - Cave surveying context for domain understanding - Testing guidelines and performance considerations Update README with comprehensive project information: - Professional project description and feature overview - Service-oriented architecture documentation - Enhanced setup instructions and development commands - Platform-specific build instructions and requirements - Device communication and export format explanations - Cross-references to detailed documentation files These improvements provide complete technical references for DMP file implementation, project contribution, and overall project understanding.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Add complete DMP file format specification:
Enhance contribution guidelines:
Update README with comprehensive project information: