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

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