Skip to content

Commit 5b7d697

Browse files
oaldersoalders
committed
HTTP-Daemon-6.02
 - Added a .mailmap to properly keep up with contributors to the dist. - Revised the changelog to follow current format styles - Change port number in test (GH#5) (Perlover)
1 parent 5e29095 commit 5b7d697

5 files changed

Lines changed: 1063 additions & 1 deletion

File tree

‎CONTRIBUTING‎

Lines changed: 107 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,107 @@
1+
2+
CONTRIBUTING
3+
4+
Thank you for considering contributing to this distribution. This file
5+
contains instructions that will help you work with the source code.
6+
7+
PLEASE NOTE that if you have any questions or difficulties, you can reach the
8+
maintainer(s) through the bug queue described later in this document
9+
(preferred), or by emailing the releaser directly. You are not required to
10+
follow any of the steps in this document to submit a patch or bug report;
11+
these are just recommendations, intended to help you (and help us help you
12+
faster).
13+
14+
The distribution is managed with Dist::Zilla (https://metacpan.org/release/Dist-Zilla).
15+
This means than many of the usual files you might expect are not in the
16+
repository, but are generated at release time (e.g. Makefile.PL).
17+
18+
However, you can run tests directly using the 'prove' tool:
19+
20+
$ prove -l
21+
$ prove -lv t/some_test_file.t
22+
$ prove -lvr t/
23+
24+
In most cases, 'prove' is entirely sufficient for you to test any patches you
25+
have.
26+
27+
You may need to satisfy some dependencies. The easiest way to satisfy
28+
dependencies is to install the last release -- this is available at
29+
https://metacpan.org/release/HTTP-Daemon
30+
31+
If you use cpanminus, you can do it without downloading the tarball first:
32+
33+
$ cpanm --reinstall --installdeps --with-recommends HTTP::Daemon
34+
35+
Dist::Zilla is a very powerful authoring tool, but requires a number of
36+
author-specific plugins. If you would like to use it for contributing,
37+
install it from CPAN, then run one of the following commands, depending on
38+
your CPAN client:
39+
40+
$ cpan `dzil authordeps --missing`
41+
or
42+
$ dzil authordeps --missing | cpanm
43+
44+
You should then also install any additional requirements not needed by the
45+
dzil build but may be needed by tests or other development:
46+
47+
$ cpan `dzil listdeps --author --missing`
48+
or
49+
$ dzil listdeps --author --missing | cpanm
50+
51+
Or, you can use the 'dzil stale' command to install all requirements at once:
52+
53+
$ cpan Dist::Zilla::App::Command::stale
54+
$ cpan `dzil stale --all`
55+
or
56+
$ cpanm Dist::Zilla::App::Command::stale
57+
$ dzil stale --all | cpanm
58+
59+
You can also do this via cpanm directly:
60+
61+
$ cpanm --reinstall --installdeps --with-develop --with-recommends HTTP::Daemon
62+
63+
Once installed, here are some dzil commands you might try:
64+
65+
$ dzil build
66+
$ dzil test
67+
$ dzil test --release
68+
$ dzil xtest
69+
$ dzil listdeps --json
70+
$ dzil build --notgz
71+
72+
You can learn more about Dist::Zilla at http://dzil.org/.
73+
74+
The code for this distribution is hosted at GitHub. The repository is:
75+
https://github.com/libwww-perl/HTTP-Daemon
76+
You can submit code changes by forking the repository, pushing your code
77+
changes to your clone, and then submitting a pull request. Please include a
78+
suitable end-user-oriented entry in the Changes file describing your change.
79+
Detailed instructions for doing that is available here:
80+
81+
https://help.github.com/articles/creating-a-pull-request
82+
83+
All pull requests for this distribution will be automatically tested on Linux
84+
by Travis at: https://travis-ci.com/libwww-perl/HTTP-Daemon
85+
Results will be visible in the pull request on GitHub. Follow the appropriate
86+
links for details when tests fail. Changes will not be mergeable until all
87+
tests pass.
88+
89+
If you have found a bug, but do not have an accompanying patch to fix it, you
90+
can submit an issue report here:
91+
https://github.com/libwww-perl/HTTP-Daemon/issues
92+
93+
94+
There is also a mailing list available for users of this distribution, at
95+
mailto:libwww@perl.org
96+
There is also an irc channel available for users of this distribution, at
97+
irc://irc.perl.org/#lwp
98+
99+
If you send me a patch or pull request, your name and email address will be
100+
included in the documentation as a contributor (using the attribution on the
101+
commit or patch), unless you specifically request for it not to be. If you
102+
wish to be listed under a different name or address, you should submit a pull
103+
request to the .mailmap file to contain the correct mapping.
104+
105+
106+
This file was generated via Dist::Zilla::Plugin::GenerateFile::FromShareDir 0.014
107+
from a template file originating in Dist-Zilla-PluginBundle-Author-ETHER-0.148.

‎Changes‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
Revision history for HTTP-Daemon
22

3-
{{$NEXT}}
3+
6.02 2019-04-01 16:03:37Z
44
- Added a .mailmap to properly keep up with contributors to the dist.
55
- Revised the changelog to follow current format styles
66
- Change port number in test (GH#5) (Perlover)

‎INSTALL‎

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
This is the Perl distribution HTTP-Daemon.
2+
3+
Installing HTTP-Daemon is straightforward.
4+
5+
## Installation with cpanm
6+
7+
If you have cpanm, you only need one line:
8+
9+
% cpanm HTTP::Daemon
10+
11+
If it does not have permission to install modules to the current perl, cpanm
12+
will automatically set up and install to a local::lib in your home directory.
13+
See the local::lib documentation (https://metacpan.org/pod/local::lib) for
14+
details on enabling it in your environment.
15+
16+
## Installing with the CPAN shell
17+
18+
Alternatively, if your CPAN shell is set up, you should just be able to do:
19+
20+
% cpan HTTP::Daemon
21+
22+
## Manual installation
23+
24+
As a last resort, you can manually install it. Download the tarball, untar it,
25+
install configure prerequisites (see below), then build it:
26+
27+
% perl Build.PL
28+
% ./Build && ./Build test
29+
30+
Then install it:
31+
32+
% ./Build install
33+
34+
Or the more portable variation:
35+
36+
% perl Build.PL
37+
% perl Build
38+
% perl Build test
39+
% perl Build install
40+
41+
If your perl is system-managed, you can create a local::lib in your home
42+
directory to install modules to. For details, see the local::lib documentation:
43+
https://metacpan.org/pod/local::lib
44+
45+
The prerequisites of this distribution will also have to be installed manually. The
46+
prerequisites are listed in one of the files: `MYMETA.yml` or `MYMETA.json` generated
47+
by running the manual build process described above.
48+
49+
## Configure Prerequisites
50+
51+
This distribution requires other modules to be installed before this
52+
distribution's installer can be run. They can be found under the
53+
"configure_requires" key of META.yml or the
54+
"{prereqs}{configure}{requires}" key of META.json.
55+
56+
## Other Prerequisites
57+
58+
This distribution may require additional modules to be installed after running
59+
Build.PL or Makefile.PL.
60+
Look for prerequisites in the following phases:
61+
62+
* to run ./Build or make, PHASE = build
63+
* to use the module code itself, PHASE = runtime
64+
* to run tests, PHASE = test
65+
66+
They can all be found in the "PHASE_requires" key of MYMETA.yml or the
67+
"{prereqs}{PHASE}{requires}" key of MYMETA.json.
68+
69+
## Documentation
70+
71+
HTTP-Daemon documentation is available as POD.
72+
You can run `perldoc` from a shell to read the documentation:
73+
74+
% perldoc HTTP::Daemon
75+
76+
For more information on installing Perl modules via CPAN, please see:
77+
https://www.cpan.org/modules/INSTALL.html

0 commit comments

Comments
 (0)