Skip to content

Commit c53db2f

Browse files
authored
Merge pull request #260 from perl6/readme.install
add an installation template file for consideration
2 parents e78aa04 + 0a2eca4 commit c53db2f

File tree

1 file changed

+43
-0
lines changed

1 file changed

+43
-0
lines changed

README.install-template.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
2+
# Example install instructions for module **Example::Module**
3+
4+
## Installation requirements
5+
6+
With a normal rakudo installation, you should have available one or
7+
both of the installer tools:
8+
9+
- `zef`
10+
- `panda`
11+
12+
`zef` is becoming the preferred tool because of more features
13+
(including an uninstall function) and more active development, but
14+
either tool should work fine for a first installation of a desired
15+
module. We'll use `zef` for the rest of the examples.
16+
17+
## Installation
18+
19+
```Perl6
20+
zef install Example::Module
21+
```
22+
23+
If the attempt shows that the module isn't found or available, ensure
24+
your installer is current:
25+
26+
```Perl6
27+
zef update
28+
```
29+
30+
If you want to use the latest version in the git repository (or it's
31+
not available in the Perl 6 ecosystem), clone it and then install it
32+
from its local directory. Here we assume the module is on Github in
33+
location "https://github.com/jhancock/Example-Module-Perl6", but use
34+
the Github clone instructions for the desired module. (Note the
35+
repository name is usually not the exact name of the module as used in
36+
Perl 6.)
37+
38+
39+
```Perl6
40+
git clone https://github.com/jhancock/Example-Module-Perl6.git
41+
cd /path/to/cloned/repository/directory
42+
zef install .
43+
```

0 commit comments

Comments
 (0)