add readme file

src/test/README.md

@@ -0,0 +1,29 @@
+----------------------------
+
+# **C++ Test Program Guide**
+
+----------------------------
+
+    Short, minimal guide to test programs that were collected over the years and left as is.
+
+    NO GUARANTEES as to functionality or effectiveness, just dig in and parse it yourself.
+
+---------------------------
+
+| File                                                                       | Function                                                                                                                                                                                                                                                                                                                                                                                       |
+|----------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| [CompactBuilder_Test.cpp](CompactBuilder_Test.cpp)                         | Compare writing evio data using the CompactEventBuilder, EventBuilder, and the original EvioEvent classes. Insert banks and search evio buffer.                                                                                                                                                                                                                                                |
+| [Dict_FirstEv_Test.cpp](Dict_FirstEv_Test.cpp)                             | Write evio data to file with EventWriter using the CompactEventBuilder and EventBuilder classes while inserting created dictionary and **first event**. Read files using EvioReader and print out.                                                                                                                                                                                             |
+| [fileTest.cpp](fileTest.cpp)                                               | Very short test to see if #include \<filesystem\> is available on this system.                                                                                                                                                                                                                                                                                                                 |
+| [FileWriteTest.cpp](FileWriteTest.cpp)                                     | Compare writing same events to file with EventWriterV4 (evio 4) and EventWriter (evio 6).                                                                                                                                                                                                                                                                                                      |
+| [hallDEventFiles.cpp](hallDEventFiles.cpp)                                 | So Esnet can test data compressibility, take a hall D data file and write out each event into a separate file (no record structure).                                                                                                                                                                                                                                                           |
+| [Hipo_Test.cpp](Hipo_Test.cpp)                                             | Create events with CompactEventBuilder, write into hipo file with Writer and read back with Reader, printout.                                                                                                                                                                                                                                                                                  |
+| [IndexArrayLenTest.cpp](IndexArrayLenTest.cpp)                             | Write evio 6 data (zero-length index array) with fwrite, read back with Reader and print. Used to test the reading of uncompressed evio buffer and file to see if changes made to handle a zero-length index array actually worked.                                                                                                                                                            |                                                                                      |
+| [ReadTest.cpp](ReadTest.cpp)                                               | Read hipo/evio file with Reader, print out # events and each event.                                                                                                                                                                                                                                                                                                                            |
+| [ReadWriteTest.cpp](ReadWriteTest.cpp)                                     | One routine writes events as EvioNodes into buf with user header or write as compressed data and reads back with Reader, EvioCompactReader and EvioReader. Defined listeners for EvioReader. Other routine writes in given byte order and with entire record. Another routine does multithreaded writes with WriterMT using first event, user header, given endian.<br/>Routines to read data. |
+| [ReadWriteV4Test.cpp](ReadWriteV4Test.cpp)                                 | This class mirrored in Java. Writes evio v4 file with EventWriterV4 with set endian, first event and dictionary, reads back. Routine to write buffer. Reads back with EvioCompactReader and EvioReader with user defined listener and filter.                                                                                                                                                  |
+| [RecordSupplyTest.cpp](RecordSupplyTest.cpp)                               | Test of RecordSupply class (based on Disruptor-cpp) with one thread getting & writing into record, multiple threads compressing records, and a thread to get and write out final record. RecordSupply is **NOT** meant to be used directly, but is used in WriterMT to do multithreaded compression.                                                                                           |
+| [RingBufferTest.cpp](RingBufferTest.cpp)                                   | Used for testing C++ based ring buffer code in prep for creating RecordSupply class. **NOT** useful for anyone.                                                                                                                                                                                                                                                                                |
+| [Tree_Buf_Composite_Builder_Test.cpp](Tree_Buf_Composite_Builder_Test.cpp) | Test EventBuilder, CompactEventBuilder, CompositeData, ByteBuffer (with memory mapping), BaseStructure's tree methods, and finding structures thru filters and listeners.                                                                                                                                                                                                                      |
+| [Writer_Reader_Compression_Test.cpp](Writer_Reader_Compression_Test.cpp)   | Write compressed evio data to file (as buffer and as EvioEvents) and read back.                                                                                                                                                                                                                                                                                                                |
+| [Writer_Reader_Test.cpp](Writer_Reader_Test.cpp)                           | Write event to buf and read, write to file and read, create 2nd event and append to file, read all events back.                                                                                                                                                                                                                                                                                |