From e7edf130bed63d7a853394b431c0c0554a8f438b Mon Sep 17 00:00:00 2001
From: Kushal K S V S <kkushal32@gmail.com>
Date: Fri, 25 Aug 2017 18:17:13 -0700
Subject: [PATCH] Update README

---
 tests/make_png/README   | 81 +++++++++++++++++++++++++----------------
 tests/make_png/runme.sh |  2 +-
 2 files changed, 51 insertions(+), 32 deletions(-)

diff --git a/tests/make_png/README b/tests/make_png/README
index a7b3e653f..a878e8332 100644
--- a/tests/make_png/README
+++ b/tests/make_png/README
@@ -1,8 +1,3 @@
- 
-TODO:   Generate HTML page for detailed comparison
-
----------------------------------------------------------------------
-
 INSTRUCTIONS
 
 NOTE: One version of FreeType is referred as "base" version and the
@@ -10,10 +5,8 @@ NOTE: One version of FreeType is referred as "base" version and the
 
   1. Get the two versions ready
   -------------------------------------
-    Make two folders named "test" and "base" preferably in the home
-    directory.
 
-    Next, download an older version of FreeType (For example : 2.6.5)
+    Download an older version of FreeType (For example : 2.6.5)
     ( This being the "base" version of the two)
     Go to 'include/freetype/ftoption.h' and uncomment this line
 
@@ -21,10 +14,10 @@ NOTE: One version of FreeType is referred as "base" version and the
   
   2. Compile the two versions 
   -------------------------------------     
-   Go to the "base" version's folder and compile the library
+   Go to the "base" version's folder and compile the library.
 
-	    ./configure --enable-shared --disable-static
-	    make 
+      ./configure --enable-shared --disable-static
+      make
 
     Repeat step 2. for the "test" version as well.
 
@@ -32,39 +25,65 @@ NOTE: One version of FreeType is referred as "base" version and the
   -------------------------------------     
     Return to this folder and make the binary
 
- 	make tests [options]
-
-    Set resolution in DPI by passing argument to variable DPI.
-    Example: make tests DPI=100, if not specified,default is 72.
-
-    Set the Rendering mode by passing FT_TEST_RENDER_MODE.
-    <render_mode> can take values 1. MONO
-    							  2. AA
-    							  3. RGB
-    							  4. BGR
-    							  5. VRGB
-    							  6. VBGR
-    ( Example: make tests FT_TEST_RENDER_MODE=RGB )
+      make tests
 
  4. Run the executable
   ------------------------------------- 
 
-	sh runme.sh <a> <font_file> <pt_size> 
+    => Set resolution in DPI by passing argument to variable FT_TEST_DPI.
+
+    => Set the Rendering mode by passing FT_TEST_RENDER_MODE.
+       FT_TEST_RENDER_MODE can take values 1. MONO
+                             2. AA
+                             3. RGB
+                             4. BGR
+                             5. VRGB
+                             6. VBGR
+
+    => Set the variables FT_TEST_BASE_DLL and FT_TEST_TEST_DLL to
+       point to the libfreetype.so file of the base and the test
+       versions respectively.
+
+       By default, the folders '$(HOME)/base/' and '$(HOME)/test/'
+       folders are set for FT_TEST_BASE_DIR and FT_TEST_TEST_DIR
+       respectively. If FT_TEST_XXX_DLL isn't defined, these values
+       are taken to search for DLL files.
 
-    <a> is directory of the 'base' FreeType version. 
-    ( The path to these should be absolute. )
+    => Set FT_TEST_FONT_FILE to the path to font files needed.
 
-	Open ./html/index.html for "list-view"
+    => set FT_TEST_PT_SIZE as a number to denote the font size.
+
+    EXAMPLE:    FT_TEST_BASE_DIR=/home/wl/kushal/base \
+          FT_TEST_TEST_DIR=/home/wl/kushal/test \
+          FT_TEST_DPI="72 96" \
+          FT_TEST_FONT_FILE="test.ttf" \
+          FT_TEST_RENDER_MODE="AA RGB" \
+          FT_TEST_PT_SIZE="16 20" \
+          ./runme.sh
+    ( The values in the above example denote the default values
+    for the variables )
+
+  Open ./html/top.html for the web interface.
 ---------------------------------------------------------------------
 
 FEATURES
 
-    Generates sprite sheets in the ./html/images folder.
+  Creates an interactive web interface to visualize glyphs.
+  (html/top.html)
 
-    Generates "list-view" web-page i.e index.html
+  View lists of glyphs in tables in the left iFrame accessed by
+  selecting values from the drop-box.
 
     By clicking on the Headers of the respective columns,they can be
     arranged (in increasing/decreasing order) based on
       ->  Glyph-Index
       ->  Name
-      ->  Difference Metric 
+      ->  Difference Metric
+
+    When clicked on any image in the table, a detailed visualization
+    page for the glyph is shown in the right iFrame.
+
+    To be ADDED ...
+
+
+
diff --git a/tests/make_png/runme.sh b/tests/make_png/runme.sh
index cacef08ba..c19e98c12 100755
--- a/tests/make_png/runme.sh
+++ b/tests/make_png/runme.sh
@@ -65,7 +65,7 @@ echo '</select>
 #####################################################################
 echo '<label>Render Mode:<select name="mode" id="mode" onchange="change()">'>>./html/top.html;
 for i in $FT_TEST_RENDER_MODE; do
-  echo "  <option value= $i > $i </option>">>./html/top.html;
+  echo "  <option value= ${arr[$i]} > $i </option>">>./html/top.html;
 done
 echo '</select>
     </label><br>'>>./html/top.html;