From 4ce389d141f978925cf52667e6dbc84326c7f9f2 Mon Sep 17 00:00:00 2001 From: my Date: Wed, 23 Oct 2019 12:22:45 +0200 Subject: [PATCH 1/9] readme v0.0 --- README.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/README.md b/README.md index 67291f7..037f78d 100644 --- a/README.md +++ b/README.md @@ -7,3 +7,25 @@ to install the full package. Installing a single component is currently not supported. +## Target + +1. TextRenderer translate the string from Terminal to a bitmap array. + the bitmap will output in the terminal and store in shared memory. + +## How to use the program + +1. You must install catch2 in your computer. + the catch2 website is https://github.com/catchorg/Catch2 + + If you cannot install Catch2 from a package manager (e.g. Ubuntu 16.04 provides catch only in version 1.2.0) + you might want to install it from the repository instead. Assuming you have enough rights, you can just + install it to the default location, like so: + ~~~~ + $ git clone https://github.com/catchorg/Catch2.git + $ cd Catch2 + $ cmake -Bbuild -H. -DBUILD_TESTING=OFF + $ sudo cmake --build build/ --target install + +2. Debug + + From ef3a6ff86b7d4ecf63bba0cc19c7998fce4fe666 Mon Sep 17 00:00:00 2001 From: my Date: Thu, 24 Oct 2019 12:14:49 +0200 Subject: [PATCH 2/9] readme v0.1 --- README.md | 33 +++++++++++++++++---------------- 1 file changed, 17 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 037f78d..4a109f7 100644 --- a/README.md +++ b/README.md @@ -9,23 +9,24 @@ Installing a single component is currently not supported. ## Target -1. TextRenderer translate the string from Terminal to a bitmap array. - the bitmap will output in the terminal and store in shared memory. +TextRender build exports an interface target TextRender::TextRender. Link against +it will add the proper include path and all necessary capablities to the +resulting binary. -## How to use the program +This means that if TextRender has been installed on the Project Path, it +should be enough to do. -1. You must install catch2 in your computer. - the catch2 website is https://github.com/catchorg/Catch2 - - If you cannot install Catch2 from a package manager (e.g. Ubuntu 16.04 provides catch only in version 1.2.0) - you might want to install it from the repository instead. Assuming you have enough rights, you can just - install it to the default location, like so: - ~~~~ - $ git clone https://github.com/catchorg/Catch2.git - $ cd Catch2 - $ cmake -Bbuild -H. -DBUILD_TESTING=OFF - $ sudo cmake --build build/ --target install - -2. Debug + ... + +## Usage + + mkdir build + cd build + cmake .. + make + +## Example + + translate() From 33247683bb07c135f72b04def781d66e6a2a12f9 Mon Sep 17 00:00:00 2001 From: my Date: Thu, 24 Oct 2019 12:16:54 +0200 Subject: [PATCH 3/9] readme v0.2 --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 4a109f7..37a9c50 100644 --- a/README.md +++ b/README.md @@ -29,4 +29,6 @@ should be enough to do. ## Example - translate() + Font font("filepath"); + char bitmap[] = font.translate("hello world"); + From e05328d9444f028548fa7a90a1036aa744cb7dd6 Mon Sep 17 00:00:00 2001 From: my Date: Thu, 24 Oct 2019 12:18:56 +0200 Subject: [PATCH 4/9] readme v0.23 --- README.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/README.md b/README.md index 37a9c50..ed0bab8 100644 --- a/README.md +++ b/README.md @@ -9,9 +9,7 @@ Installing a single component is currently not supported. ## Target -TextRender build exports an interface target TextRender::TextRender. Link against -it will add the proper include path and all necessary capablities to the -resulting binary. +TextRender build exports an interface target TextRender::TextRender. This means that if TextRender has been installed on the Project Path, it should be enough to do. From 46dd1180100e81d62b7c1e8a52b0fdb6441f9473 Mon Sep 17 00:00:00 2001 From: my Date: Thu, 24 Oct 2019 12:20:28 +0200 Subject: [PATCH 5/9] readme v0.23 --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index ed0bab8..2a7d397 100644 --- a/README.md +++ b/README.md @@ -28,5 +28,5 @@ should be enough to do. ## Example Font font("filepath"); - char bitmap[] = font.translate("hello world"); + char bitmap[] = font.translate("hello world"); (not work now) From a384a7b927f5fc7ea1c337d2b0a8df8ec39813f5 Mon Sep 17 00:00:00 2001 From: my Date: Tue, 29 Oct 2019 12:50:43 +0100 Subject: [PATCH 6/9] readme update 0.1 --- README.md | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 2a7d397..d993872 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,9 @@ TextRender build exports an interface target TextRender::TextRender. This means that if TextRender has been installed on the Project Path, it should be enough to do. - ... +translate a string from terminal to the readable form of FLTK . + + @@ -27,6 +29,9 @@ should be enough to do. ## Example - Font font("filepath"); - char bitmap[] = font.translate("hello world"); (not work now) - + TextRenderer textRenderer; + + string bitmap = textRenderer.translate(testString); + + textRenderer.outputInscreen(bitmap); + \ No newline at end of file From c51063359b92a5215f91ed63aa03c3ca65b6daaa Mon Sep 17 00:00:00 2001 From: my Date: Tue, 29 Oct 2019 13:25:46 +0100 Subject: [PATCH 7/9] readme update 0.2 --- README.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index d993872..caf3939 100644 --- a/README.md +++ b/README.md @@ -14,11 +14,7 @@ TextRender build exports an interface target TextRender::TextRender. This means that if TextRender has been installed on the Project Path, it should be enough to do. -translate a string from terminal to the readable form of FLTK . - - - - +translate a string from terminal to the readable form of shared memory . ## Usage @@ -27,11 +23,15 @@ translate a string from terminal to the readable form of FLTK . cmake .. make -## Example +## Description - TextRenderer textRenderer; +TextRender has two class, Bitmap class and Font class. - string bitmap = textRenderer.translate(testString); +res/font.bmp (bitmap data, used by Bitmap::load() function) - textRenderer.outputInscreen(bitmap); - \ No newline at end of file +res/font.toml (configuration file, it configure how to read the font.bmp) + +src/Bitmap class, it used to load the font.bmp file. + +src/Font class, it read the font.bmp data by Bitmap class, +translate a string to a bitmap \ No newline at end of file From 742941ebdbd55904be32c123604da328c0942822 Mon Sep 17 00:00:00 2001 From: my Date: Tue, 29 Oct 2019 13:27:36 +0100 Subject: [PATCH 8/9] readme update 0.3 --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index caf3939..8463eb5 100644 --- a/README.md +++ b/README.md @@ -34,4 +34,8 @@ res/font.toml (configuration file, it configure how to read the font.bmp) src/Bitmap class, it used to load the font.bmp file. src/Font class, it read the font.bmp data by Bitmap class, -translate a string to a bitmap \ No newline at end of file +translate a string to a bitmap + +test folder used to test. + +main folder is only used to test now. \ No newline at end of file From 82f878b9ec343d2b16201b7799410a5c2c09f796 Mon Sep 17 00:00:00 2001 From: my Date: Tue, 29 Oct 2019 13:29:46 +0100 Subject: [PATCH 9/9] readme update 0.4 --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 8463eb5..cdadfe7 100644 --- a/README.md +++ b/README.md @@ -31,10 +31,10 @@ res/font.bmp (bitmap data, used by Bitmap::load() function) res/font.toml (configuration file, it configure how to read the font.bmp) -src/Bitmap class, it used to load the font.bmp file. +src/Bitmap class, it used to read the font.bmp file. src/Font class, it read the font.bmp data by Bitmap class, -translate a string to a bitmap +translate a string to a bitmap. test folder used to test.