Skip to content

Commit 00721b9

Browse files
authored
Merge pull request #80 from end2endzone/feature-issue77
Refactor generating code to use full file templates with markers
2 parents 3a5f0d2 + 5671223 commit 00721b9

27 files changed

+1844
-1717
lines changed

CHANGES

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ Changes for 3.1.0:
77
* Fixed issue #64: Remove build artifacts of samples from installation packages.
88
* Fixed issue #72: Move the code FileManager class generation code into its own IGenerator implementation.
99
* Fixed issue #74: Invalid generated output file name: index.cpptml.cpp.
10+
* Fixed issue #77: Refactor generating code to use full file templates with markers.
1011

1112

1213
Changes for 3.0.1:

README.md

Lines changed: 6 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@
55
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
66
[![Github Releases](https://img.shields.io/github/release/end2endzone/bin2cpp.svg)](https://github.com/end2endzone/bin2cpp/releases)
77

8-
bin2cpp is a command line tool for embedding small files (like images, icons or raw data files) into a C++ executable.
8+
bin2cpp is a command line tool for embedding small files (like images, icons or raw data files) into a C or C++ executable.
99

10-
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.
10+
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.
1111

1212

1313

@@ -22,13 +22,6 @@ Build:
2222
| 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) |
2323
| 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) |
2424

25-
Statistics:
26-
27-
| AppVeyor | Travic CI | GitHub |
28-
| ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- |
29-
| [![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/) |
30-
31-
3225

3326

3427
# Purpose
@@ -46,24 +39,24 @@ The generated functions that reads and extracts the embedded content does not re
4639

4740
The main features of the project are:
4841

49-
* Easily converts small files as C++ source code for embedding into a C++ executable.
42+
* Easily converts small files to C or C++ source code for embedding into an executable.
5043
* Access content with a unique function call for each embedded file.
5144
* Supports multiple embedded files at once.
5245
* Keep the directory structure when embedding directories.
5346
* Supports encoding and extracting files with a custom directory structure.
5447
* Makes it harder for resource hacker to modify or steal the embedded files.
5548
* No third party libraries required for retrieving the data of the embedded files.
5649
* Supports different types of code generator: string, segment, array, win32 resources.
57-
* File's originals `size`, `filename` and `directory` properties available from generated source code.
50+
* File's originals `size`, `filename` and `relative path` properties available from generated source code.
5851
* Control generated source code: choose your custom _File_ interface and namespace.
5952
* Print a file encoded content to stdout. Useful for scripts and integration with third party application.
60-
* Generated code is C++98 standard-compliant.
53+
* Generated code is C99 or C++98 standard-compliant.
6154

6255

6356

6457
## Use cases
6558

66-
The following list show situations where bin2cpp is useful:
59+
The following list show use cases where bin2cpp is useful:
6760

6861
* Embedding default configuration files if none are provided.
6962
* Embedding GLSL shaders into the executable.

0 commit comments

Comments
 (0)