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