[prev in list] [next in list] [prev in thread] [next in thread] 

List:       pecl-cvs
Subject:    [PECL-CVS] com pecl/php/uploadprogress: Use Markdown for README: README README.md
From:       Peter Kokot <petk () php ! net>
Date:       2019-04-24 16:19:17
Message-ID: php-mail-3b5b6b07135252c3ed3a8be5f64d2deb1019629442 () git ! php ! net
[Download RAW message or body]

Commit:    0c5cc0c14c3489697ffd8c31865ccb1c0c1f8513
Author:    Peter Kokot <peterkokot@gmail.com>         Wed, 24 Apr 2019 18:19:17 +0200
Parents:   fa1d17330c2565c464ac82dfdc993d8e7f303281
Branches:  master

Link:       http://git.php.net/?p=pecl/php/uploadprogress.git;a=commitdiff;h=0c5cc0c14c3489697ffd8c31865ccb1c0c1f8513


Log:
Use Markdown for README

Changed paths:
  D  README
  A  README.md


Diff:
diff --git a/README b/README
deleted file mode 100644
index 9186267..0000000
--- a/README
+++ /dev/null
@@ -1,72 +0,0 @@
-This is a standalone PHP extension created using PECL_Gen 0.8.5
-
-HACKING
-=======
-
-There are two ways to modify an extension created using PECL_Gen:
-
-1) you can modify the generated code as with any other PHP extension
-
-2) you can add custom code to the PECL_Gen XML source and re-run pecl-gen
-
-The 2nd approach may look a bit complicated but you have be aware that any
-manual changes to the generated code will be lost if you ever change the
-XML specs and re-run PECL-Gen. All changes done before have to be applied
-to the newly generated code again.
-Adding code snippets to the XML source itself on the other hand may be a
-bit more complicated but this way your custom code will always be in the
-generated code no matter how often you rerun PECL_Gen.
-
-
-BUILDING ON UNIX etc.
-=====================
-
-To compile your new extension, you will have to execute the following steps:
-
-1.  $ ./phpize
-2.  $ ./configure [--enable-uploadprogress]
-3.  $ make
-[4. $ make test ] # NOTE: this doesn't work right now *)
-5.  $ [sudo] make install
-
-*) this is a general problem with "make test" and standalone extensions
-   (that is being worked on) so please don't blame PECL_Gen for this
-
-
-
-BUILDING ON WINDOWS
-===================
-
-The extension provides the VisualStudio V6 project file
-
-  uploadprogress.dsp
-To compile the extension you open this file using VisualStudio,
-select the apropriate configuration for your installation
-(either "Release_TS" or "Debug_TS") and create "php_uploadprogress.dll"
-
-After successfull compilation you have to copy the newly
-created "php_uploadprogress.dll" to the PHP
-extension directory (default: C:\PHP\extensions).
-
-
-TESTING
-=======
-
-You can now load the extension using a php.ini directive
-
-  extension="php_uploadprogress.[so|dll]"
-
-or load it at runtime using the dl() function
-
-  dl("php_uploadprogress.[so|dll]");
-
-The extension should now be available, you can test this
-using the extension_loaded() function:
-
-  if (extension_loaded(uploadprogress))
-    echo "uploadprogress loaded :)";
-  else
-    echo "something is wrong :(";
-
-The extension will also add its own block to the output
-of phpinfo();
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..6f8d363
--- /dev/null
+++ b/README.md
@@ -0,0 +1,67 @@
+# uploadprogress
+
+This is a standalone PHP extension created using PECL_Gen 0.8.5.
+
+## Hacking
+
+There are two ways to modify an extension created using PECL_Gen:
+
+1. You can modify the generated code as with any other PHP extension
+
+2. You can add custom code to the PECL_Gen XML source and re-run pecl-gen
+
+The 2nd approach may look a bit complicated but you have be aware that any
+manual changes to the generated code will be lost if you ever change the XML
+specs and re-run PECL-Gen. All changes done before have to be applied to the
+newly generated code again.
+
+Adding code snippets to the XML source itself on the other hand may be a bit
+more complicated but this way your custom code will always be in the generated
+code no matter how often you rerun PECL_Gen.
+
+## Building on *nix systems
+
+To compile your new extension, you will have to execute the following steps:
+
+1. $ ./phpize
+2. $ ./configure [--enable-uploadprogress]
+3. $ make
+4. $ make test # NOTE: this doesn't work right now
+5. $ [sudo] make install
+
+## Building on Windows
+
+The extension provides the VisualStudio V6 project file
+
+    uploadprogress.dsp
+
+To compile the extension you open this file using VisualStudio, select the
+apropriate configuration for your installation (either "Release_TS" or
+"Debug_TS") and create `php_uploadprogress.dll`.
+
+After successfull compilation you have to copy the newly created
+`php_uploadprogress.dll` to the PHP extension directory (default:
+`C:\PHP\extensions`).
+
+## Testing
+
+You can now load the extension using a php.ini directive
+
+    extension="php_uploadprogress.[so|dll]"
+
+or load it at runtime using the dl() function
+
+    dl("php_uploadprogress.[so|dll]");
+
+The extension should now be available, you can test this using the
+`extension_loaded()` function:
+
+```php
+if (extension_loaded(uploadprogress)) {
+    echo "uploadprogress loaded :)";
+} else  {
+    echo "something is wrong :(";
+}
+```
+
+The extension will also add its own block to the output of `phpinfo()`;


--
PECL CVS Mailing List
To unsubscribe, visit: http://www.php.net/unsub.php


[prev in list] [next in list] [prev in thread] [next in thread]