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