Skip to content

Commit 3b87553

Browse files
author
Stuart Cording
committed
Added README.md
Same as original README file, just now with .md extension. Hopefully github will now format this correctly.
1 parent f6af78d commit 3b87553

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

README.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
Intel HEX Class Project
2+
=======================
3+
4+
Introduction to the Intel HEX Class Module
5+
------------------------------------------
6+
The Intel HEX Class Module is designed to allow the programmer to easily work with Intel HEX files. Using standard C++ stream operators it is possible to decode a file into memory and then to examine the entire content of the file much more easily than if the original file was simply opened in a text editor.
7+
8+
Additionally, again using a C++ stream operator, it is possible to encode the current data in memory back into Intel HEX format again straight to a file.
9+
10+
Using this class it is also possible to:
11+
12+
* Generate Intel HEX files with your own content
13+
* Fill blank areas of an Intel HEX file with a desired value or pattern
14+
* Merge two or more files together
15+
* Selectively merge parts of two or more files together
16+
* Check an Intel HEX file for correctness and integrity (correct construction, checksums ok, etc.)
17+
18+
Key Software Capabilities
19+
-------------------------
20+
* Stream Intel HEX file content into class for decoding
21+
* Stream data stored in memory out from class in Intel HEX format to a file
22+
* 'Never give up' approach to decoding; warning and error messages can be examined upon completion; as much as humanely possible will have been decoded.
23+
* Class contains no 'try' calls; will always return cleanly for programmer to make decision how to proceed.
24+
* File sizes up to 4GB supported (system dependent).
25+
* All records as per the official Intel "Hexadecimal Object File Format Specification, Revision A, January 6, 1988" supported
26+
27+
Project Page
28+
------------
29+
30+
For all current information, visit the project page at [codinghead.github.com/Intel-HEX-Class](http://codinghead.github.com/Intel-HEX-Class/).

0 commit comments

Comments
 (0)