Updated README.md for #53

Author: end2endzone

README.md

@@ -5,9 +5,9 @@
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 [![Github Releases](https://img.shields.io/github/release/end2endzone/bin2cpp.svg)](https://github.com/end2endzone/bin2cpp/releases)
 
-bin2cpp is a command line tool for embedding small files (like images, icons or raw data files) into a C++ executable.
+bin2cpp is a command line tool for embedding small files (like images, icons or raw data files) into a C or C++ executable.
 
-When executed, bin2cpp takes binary file as input and outputs c++ code (a function) that when called allows a c++ program to retrieve the content of the input binary file.
+When executed, bin2cpp takes binary file as input and outputs C or C++ code (a function) that when called allows a program to retrieve the content of the input binary file.
 
 
 
@@ -22,13 +22,6 @@ Build:
 | Ubuntu 20.04        | [![Build on Linux](https://github.com/end2endzone/bin2cpp/actions/workflows/build_linux.yml/badge.svg)](https://github.com/end2endzone/bin2cpp/actions/workflows/build_linux.yml)       | [![Tests on Linux](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/end2endzone/58cf6c72c08e706335337d5ef9ca48e8/raw/bin2cpp.master.Linux.json)](https://github.com/end2endzone/bin2cpp/actions/workflows/build_linux.yml)       |
 | macOS 10.15         | [![Build on macOS](https://github.com/end2endzone/bin2cpp/actions/workflows/build_macos.yml/badge.svg)](https://github.com/end2endzone/bin2cpp/actions/workflows/build_macos.yml)       | [![Tests on macOS](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/end2endzone/58cf6c72c08e706335337d5ef9ca48e8/raw/bin2cpp.master.macOS.json)](https://github.com/end2endzone/bin2cpp/actions/workflows/build_macos.yml)       |
 
-Statistics:
-
-| AppVeyor                                                                                                                                       | Travic CI                                                                                                              | GitHub                                                                                                                     |
-| ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- |
-| [![Statistics](https://buildstats.info/appveyor/chart/end2endzone/bin2cpp)](https://ci.appveyor.com/project/end2endzone/bin2cpp/branch/master) | [![Statistics](https://buildstats.info/travisci/chart/end2endzone/bin2cpp)](https://travis-ci.org/end2endzone/bin2cpp) | [![Statistics](https://buildstats.info/github/chart/end2endzone/bin2cpp)](https://github.com/end2endzone/bin2cpp/actions/) |
-
-
 
 
 # Purpose
@@ -46,24 +39,24 @@ The generated functions that reads and extracts the embedded content does not re
 
 The main features of the project are:
 
-* Easily converts small files as C++ source code for embedding into a C++ executable.
+* Easily converts small files to C or C++ source code for embedding into an executable.
 * Access content with a unique function call for each embedded file.
 * Supports multiple embedded files at once.
 * Keep the directory structure when embedding directories.
 * Supports encoding and extracting files with a custom directory structure.
 * Makes it harder for resource hacker to modify or steal the embedded files.
 * No third party libraries required for retrieving the data of the embedded files.
 * Supports different types of code generator: string, segment, array, win32 resources.
-* File's originals `size`, `filename` and `directory` properties available from generated source code.
+* File's originals `size`, `filename` and `relative path` properties available from generated source code.
 * Control generated source code: choose your custom _File_ interface and namespace.
 * Print a file encoded content to stdout. Useful for scripts and integration with third party application.
-* Generated code is C++98 standard-compliant.
+* Generated code is C99 or C++98 standard-compliant.
 
 
 
 ## Use cases
 
-The following list show situations where bin2cpp is useful:
+The following list show use cases where bin2cpp is useful:
 
 * Embedding default configuration files if none are provided.
 * Embedding GLSL shaders into the executable.

src/bin2cpp/bin2cpp.samples.txt

@@ -9,10 +9,10 @@ Test all generators:
 --file=..\..\test\bin2cpp_unittest\generated_files\testHtml100000\testHtml100000.bin --output=..\..\test\bin2cpp_unittest\generated_files\testHtml100000 --headerfile=_testHtml100000_C.h --override --code=c --generator=win32
 
 Test as much features as possible with all generators:
---file=..\..\test\bin2cpp_unittest\generated_files\testHtml100000\testHtml100000.bin --output=..\..\temp --headerfile=c_tim_testHtml100000.h --identifier=LibFooFOO --chunksize=75 --baseclass=ben --namespace=ray --managerfile=c_tim_filemanager.h --registerfile --override --code=c --generator=array
---file=..\..\test\bin2cpp_unittest\generated_files\testHtml100000\testHtml100000.bin --output=..\..\temp --headerfile=c_jim_testHtml100000.h --identifier=LibBarBAR --chunksize=75 --baseclass=tom --namespace=eva --managerfile=c_jim_filemanager.h --registerfile --override --code=c --generator=segment
---file=..\..\test\bin2cpp_unittest\generated_files\testHtml100000\testHtml100000.bin --output=..\..\temp --headerfile=c_lou_testHtml100000.h --identifier=LibBazBAZ --chunksize=75 --baseclass=sam --namespace=joe --managerfile=c_lou_filemanager.h --registerfile --override --code=c --generator=string
---file=..\..\test\bin2cpp_unittest\generated_files\testHtml100000\testHtml100000.bin --output=..\..\temp --headerfile=c_sue_testHtml100000.h --identifier=LibBobBOB --chunksize=75 --baseclass=leo --namespace=jon --managerfile=c_sue_filemanager.h --registerfile --override --code=c --generator=win32
+--file=..\..\test\bin2cpp_unittest\generated_files\testHtml100000\testHtml100000.bin --output=..\..\temp --headerfile=c_tim_testHtml100000_array.h   --identifier=LibFooFOO --chunksize=75 --baseclass=ben --namespace=ray --managerfile=c_tim_filemanager.h --registerfile --override --code=c --generator=array
+--file=..\..\test\bin2cpp_unittest\generated_files\testHtml100000\testHtml100000.bin --output=..\..\temp --headerfile=c_jim_testHtml100000_segment.h --identifier=LibBarBAR --chunksize=75 --baseclass=tom --namespace=eva --managerfile=c_jim_filemanager.h --registerfile --override --code=c --generator=segment
+--file=..\..\test\bin2cpp_unittest\generated_files\testHtml100000\testHtml100000.bin --output=..\..\temp --headerfile=c_lou_testHtml100000_string.h  --identifier=LibBazBAZ --chunksize=75 --baseclass=sam --namespace=joe --managerfile=c_lou_filemanager.h --registerfile --override --code=c --generator=string
+--file=..\..\test\bin2cpp_unittest\generated_files\testHtml100000\testHtml100000.bin --output=..\..\temp --headerfile=c_sue_testHtml100000_win32.h   --identifier=LibBobBOB --chunksize=75 --baseclass=leo --namespace=jon --managerfile=c_sue_filemanager.h --registerfile --override --code=c --generator=win32
 
 Test for:
   * Segment C generator
@@ -44,11 +44,17 @@ Test all generators
 --file=..\..\test\bin2cpp_unittest\generated_files\testGeneratorString10000\testGeneratorString10000.bin    --output=..\..\test\bin2cpp_unittest\generated_files\testGeneratorString10000   --headerfile=_testGeneratorString10000.h   --identifier=testGeneratorString10000  --chunksize=450 --override --generator=string
 --file=..\..\test\bin2cpp_unittest\generated_files\testGeneratorWin32\testGeneratorWin32.bin                --output=..\..\test\bin2cpp_unittest\generated_files\testGeneratorWin32         --headerfile=_testGeneratorWin32.h         --identifier=testGeneratorWin32        --chunksize=450 --override --generator=win32
 
+Compare all generators:
+--file=..\..\test\bin2cpp_unittest\generated_files\testGeneratorSegment10000\testGeneratorSegment10000.bin --output=..\..\temp --headerfile=cpp_tim_testHtml100000_array.h   --identifier=LibArray   --chunksize=75 --registerfile --override --generator=array
+--file=..\..\test\bin2cpp_unittest\generated_files\testGeneratorSegment10000\testGeneratorSegment10000.bin --output=..\..\temp --headerfile=cpp_jim_testHtml100000_segment.h --identifier=LibSegment --chunksize=75 --registerfile --override --generator=segment
+--file=..\..\test\bin2cpp_unittest\generated_files\testGeneratorSegment10000\testGeneratorSegment10000.bin --output=..\..\temp --headerfile=cpp_lou_testHtml100000_string.h  --identifier=LibString  --chunksize=75 --registerfile --override --generator=string
+--file=..\..\test\bin2cpp_unittest\generated_files\testGeneratorSegment10000\testGeneratorSegment10000.bin --output=..\..\temp --headerfile=cpp_sue_testHtml100000_win32.h   --identifier=LibWin32   --chunksize=75 --registerfile --override --generator=win32
+
 Test as much features as possible with all generators:
---file=..\..\test\bin2cpp_unittest\generated_files\testHtml100000\testHtml100000.bin --output=..\..\temp --headerfile=cpp_tim_testHtml100000.h --identifier=LibFooFOO --chunksize=75 --baseclass=ben --namespace=ray --managerfile=cpp_tim_filemanager.h --registerfile --override --code=cpp --generator=array
---file=..\..\test\bin2cpp_unittest\generated_files\testHtml100000\testHtml100000.bin --output=..\..\temp --headerfile=cpp_jim_testHtml100000.h --identifier=LibBarBAR --chunksize=75 --baseclass=tom --namespace=eva --managerfile=cpp_jim_filemanager.h --registerfile --override --code=cpp --generator=segment
---file=..\..\test\bin2cpp_unittest\generated_files\testHtml100000\testHtml100000.bin --output=..\..\temp --headerfile=cpp_lou_testHtml100000.h --identifier=LibBazBAZ --chunksize=75 --baseclass=sam --namespace=joe --managerfile=cpp_lou_filemanager.h --registerfile --override --code=cpp --generator=string
---file=..\..\test\bin2cpp_unittest\generated_files\testHtml100000\testHtml100000.bin --output=..\..\temp --headerfile=cpp_sue_testHtml100000.h --identifier=LibBobBOB --chunksize=75 --baseclass=leo --namespace=jon --managerfile=cpp_sue_filemanager.h --registerfile --override --code=cpp --generator=win32
+--file=..\..\test\bin2cpp_unittest\generated_files\testHtml100000\testHtml100000.bin --output=..\..\temp --headerfile=cpp_tim_testHtml100000_array.h   --identifier=LibFooFOO --chunksize=75 --baseclass=ben --namespace=ray --managerfile=cpp_tim_filemanager.h --registerfile --override --code=cpp --generator=array
+--file=..\..\test\bin2cpp_unittest\generated_files\testHtml100000\testHtml100000.bin --output=..\..\temp --headerfile=cpp_jim_testHtml100000_segment.h --identifier=LibBarBAR --chunksize=75 --baseclass=tom --namespace=eva --managerfile=cpp_jim_filemanager.h --registerfile --override --code=cpp --generator=segment
+--file=..\..\test\bin2cpp_unittest\generated_files\testHtml100000\testHtml100000.bin --output=..\..\temp --headerfile=cpp_lou_testHtml100000_string.h  --identifier=LibBazBAZ --chunksize=75 --baseclass=sam --namespace=joe --managerfile=cpp_lou_filemanager.h --registerfile --override --code=cpp --generator=string
+--file=..\..\test\bin2cpp_unittest\generated_files\testHtml100000\testHtml100000.bin --output=..\..\temp --headerfile=cpp_sue_testHtml100000_win32.h   --identifier=LibBobBOB --chunksize=75 --baseclass=leo --namespace=jon --managerfile=cpp_sue_filemanager.h --registerfile --override --code=cpp --generator=win32
 
 Test plain output:
 --plainoutput --chunksize=75 --file=..\..\test\bin2cpp_unittest\generated_files\testSequential1000\testSequential1000.bin --generator=array