git.m6w6.name Git - m6w6/repo-template/blob - presets/README.md

   1 <?php extract($_ENV); ?>
   2 # <?=$REPO?>
   3
   4
   5 [![Build Status](https://travis-ci.org/m6w6/<?=$REPO?>.svg?branch=master)](https://travis-ci.org/m6w6/<?=$REPO?>)
   6
   7 ## Documentation
   8
   9 <?php if (isset($PECL)) : ?>
  10 See the [online markdown reference](https://mdref.m6w6.name/<?=$PECL?>).
  11
  12 Known issues are listed in [BUGS](./BUGS) and future ideas can be found in [TODO](./TODO).
  13 <?php endif; ?>
  14
  15 ## Installing
  16 <?php if (isset($COMPOSER)) : ?>
  17
  18 ### Composer
  19
  20         composer require m6w6/<?=$REPO?>
  21
  22
  23 ## ChangeLog
  24
  25 A comprehensive list of changes can be obtained from the
  26 [releases overview](./releases).
  27 <?php endif; ?>
  28 <?php if (isset($PECL)) : ?>
  29
  30 ### PECL
  31
  32         pecl install <?=$PECL?>
  33
  34
  35 ### PHARext
  36
  37 Watch out for [PECL replicates](https://replicator.pharext.org?<?=$PECL?>)
  38 and pharext packages attached to [releases](./releases).
  39
  40 ### Checkout
  41
  42         git clone github.com:m6w6/<?=$REPO?>
  43
  44         cd <?=$REPO?>
  45
  46         /path/to/phpize
  47         ./configure --with-php-config=/path/to/php-config
  48         make
  49         sudo make install
  50
  51 ## ChangeLog
  52
  53 A comprehensive list of changes can be obtained from the
  54 [PECL website](https://pecl.php.net/package-changelog.php?package=<?=$PECL?>).
  55 <?php endif; ?>
  56 <?php if (isset($AUTOTOOLS)) : ?>
  57
  58 ### Release
  59
  60         tar xf <?=$REPO?>-*.t*
  61         cd <?=$REPO?>-*.t*
  62         ./configure
  63         make
  64         sudo make install
  65
  66 ### Checkout
  67
  68         git clone github.com:m6w6/<?=$REPO?>
  69
  70         cd <?=$REPO?>
  71
  72         autoreconf -is
  73         ./configure
  74         make
  75         sudo make install
  76
  77 ## ChangeLog
  78
  79 Check out the latest [releases](./releases) or the bundled
  80 [ChangeLog](./ChangeLog) for a comprehensive list of changes.
  81 <?php endif; ?>
  82
  83 ## License
  84
  85 <?=$REPO?> is licensed under the 2-Clause-BSD license, which can be found in
  86 the accompanying [LICENSE](./LICENSE) file.
  87
  88 ## Contributing
  89
  90 All forms of contribution are welcome! Please see the bundled
  91 [CONTRIBUTING](./CONTRIBUTING.md) note for the general principles followed.
  92
  93 The list of past and current contributors is maintained in [THANKS](./THANKS).