Merge pull request #2 from YetiForceCompany/developer

Developer

CREDITS.txt

@@ -21,9 +21,9 @@ CREDITS From HTML2FPDF:
 
 -Olivier Plathey for the fpdf.php class [http://www.fpdf.org]
 -Damon Kohler for the Flowing Block script [mailto:[email protected]]
--Cl�ment Lavoillotte for HTML-oriented FPDF idea
+-Clément Lavoillotte for HTML-oriented FPDF idea
 -Yamasoft for the gif.php class [http://www.yamasoft.com/]
--J�r�me Fenal for the _parsegif() function
+-Jérôme Fenal for the _parsegif() function
 -"VIETCOM" for the PDFTable code [http://www.freepgs.com/vietcom/tool/pdftable/] [mailto:[email protected]]
 -Yukihiro O. for the SetDash() function [mailto:[email protected]]
 -Ron Korving for the WordWrap() function
@@ -69,14 +69,14 @@ CREDITS From HTML2FPDF:
    * @link http://www.ar-php.org
    * @author Khaled Al-Shamaa <[email protected]>
    * @desc   Set of PHP5 / UTF-8 Classes developed to enhance Arabic web
-   *         applications by providing set of tools includes stem-based searching, 
+   *         applications by providing set of tools includes stem-based searching,
    *         translitiration, soundex, Hijri calendar, charset detection and
-   *         converter, spell numbers, keyboard language, Muslim prayer time, 
+   *         converter, spell numbers, keyboard language, Muslim prayer time,
    *         auto-summarization, and more...
    * @package Arabic
-   *    
+   *
    * @version 1.8 released in Feb 15, 2009
-   * 
+   *
    * @license LGPL
 ****************************************************************************/
 
@@ -89,4 +89,3 @@ but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 Lesser General Public License for more details.
 [http://www.opensource.org/licenses/lgpl-license.php]
-

MpdfException.php

@@ -0,0 +1,6 @@
+<?php
+
+class MpdfException extends Exception
+{
+
+}

README.md

@@ -0,0 +1,52 @@
+mPDF is a PHP class which generates PDF files from UTF-8 encoded HTML. It is based on [FPDF](http://www.fpdf.org/)
+and [HTML2FPDF](http://html2fpdf.sourceforge.net/) (see [CREDITS](CREDITS.txt)), with a number of enhancements.
+mPDF was written by Ian Back and is released under the [GNU GPL v2 licence](LICENSE.txt).
+
+[![Build Status](https://travis-ci.org/mpdf/mpdf.svg?branch=development)](https://travis-ci.org/mpdf/mpdf)
+
+Installation
+============
+
+Preferred installation method is via composer and its packagist package [mpdf/mpdf](https://packagist.org/packages/mpdf/mpdf).
+
+Manual installation
+-------------------
+
+   * Download the [.zip release file](https://github.com/mpdf/mpdf/releases) and unzip it
+   * Create a folder e.g. /mpdf on your server
+   * Upload all of the files to the server, maintaining the folders as they are
+   * Ensure that you have write permissions set (CHMOD 6xx or 7xx) for the following folders:
+
+     /ttfontdata/ - used to cache font data; improves performance a lot
+
+     /tmp/ - used for some images and ProgressBar
+
+     /graph_cache/ - if you are using [JpGraph](http://jpgraph.net) in conjunction with mPDF
+
+To test the installation, point your browser to the basic example file:
+
+    [path_to_mpdf_folder]/mpdf/examples/example01_basic.php
+
+If you wish to define a different folder for temporary files rather than /tmp/ see the note on
+[Folder for temporary files](https://mpdf.github.io/installation-setup/folders-for-temporary-files.html)
+in the section on Installation & Setup in the [manual](https://mpdf.github.io/).
+
+If you have problems, please read the section on [troubleshooting](https://mpdf.github.io/troubleshooting/known-issues.html) in the manual.
+
+Online manual
+=============
+
+Online manual is available at https://mpdf.github.io/.
+
+Unit Testing
+============
+
+Unit testing for mPDF is done using [PHPUnit](https://phpunit.de/).
+
+To get started, run `composer install` from the command line while in the mPDF root directory
+(you'll need [composer installed first](https://getcomposer.org/download/)).
+
+To execute tests, run `vendor/bin/phpunit` from the command line while in the mPDF root directory.
+
+Any assistance writing unit tests for mPDF is greatly appreciated. If you'd like to help, please
+note that any PHP file located in the `/tests/` directory will be autoloaded when unit testing.