git.m6w6.name Git - m6w6/ext-raphf/blob - README.md

   1 # ext-raphf
   2
   3 [![Build Status](https://travis-ci.org/m6w6/ext-raphf.svg?branch=master)](https://travis-ci.org/m6w6/ext-raphf)
   4
   5 The "Resource and Persistent Handle Factory" extension provides facilities to manage those in a convenient manner.
   6
   7 ## Documentation
   8
   9 See the [online markdown reference](https://mdref.m6w6.name/raphf).
  10
  11 Known issues are listed in [BUGS](./BUGS) and future ideas can be found in [TODO](./TODO).
  12
  13 ## Installing
  14
  15 ### PECL
  16
  17         pecl install raphf
  18
  19 ### PHARext
  20
  21 Watch out for [PECL replicates](https://replicator.pharext.org?raphf)
  22 and pharext packages attached to [releases](https://github.com/m6w6/ext-raphf/releases).
  23
  24 ### Checkout
  25
  26         git clone github.com:m6w6/ext-raphf
  27         cd ext-raphf
  28         /path/to/phpize
  29         ./configure --with-php-config=/path/to/php-config
  30         make
  31         sudo make install
  32
  33 ## ChangeLog
  34
  35 A comprehensive list of changes can be obtained from the
  36 [PECL website](https://pecl.php.net/package-changelog.php?package=raphf).
  37
  38 ## License
  39
  40 ext-raphf is licensed under the 2-Clause-BSD license, which can be found in
  41 the accompanying [LICENSE](./LICENSE) file.
  42
  43 ## Contributing
  44
  45 All forms of contribution are welcome! Please see the bundled
  46 [CONTRIBUTING](./CONTRIBUTING.md) note for the general principles followed.
  47
  48 The list of past and current contributors is maintained in [THANKS](./THANKS).