File: README.rst

package info (click to toggle)
libapp-cell-perl 0.231-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, forky, sid, trixie
  • size: 412 kB
  • sloc: perl: 2,303; makefile: 2
file content (78 lines) | stat: -r--r--r-- 2,071 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
=========
App::CELL
=========

.. image:: https://travis-ci.org/smithfarm/cell.svg?branch=master :target: https://travis-ci.org/smithfarm/cell

.. image:: https://badge.fury.io/pl/App-CELL.svg
    :target: https://badge.fury.io/pl/App-CELL

--------------------------------------------------------------------
Configuration, Error-handling, Localization, and Logging "framework"
--------------------------------------------------------------------


General Documentation
=====================

* http://metacpan.org/pod/App::CELL::Guide

* http://metacpan.org/pod/App::CELL
* http://metacpan.org/pod/App::CELL::Config
* http://metacpan.org/pod/App::CELL::Load
* http://metacpan.org/pod/App::CELL::Log
* http://metacpan.org/pod/App::CELL::Message
* http://metacpan.org/pod/App::CELL::Status
* http://metacpan.org/pod/App::CELL::Test
* http://metacpan.org/pod/App::CELL::Test::LogToFile


Contributor Documentation
=========================

All would-be contributors should first read ``CONTRIBUTING.rst``.


Maintainer Documentation
========================

Read on only if you are a maintainer of ``App::CELL``


How to build and run tests
--------------------------

First, install build and runtime dependencies. This can be done either by
installing packages from your favorite Linux distribution or direct from CPAN
using a tool such as ``cpanm``.

Second, build and install the distro:

    $ perl Build.PL ; ./Build ; sudo ./Build install

Third, run the tests:

    $ prove -l t/

To ease the pain, a script called ``bootstrap.sh`` is provided. This script
automates all three of the steps just described.

To include the "Perl Critic" and "Check Manifest" tests, do::

    $ sudo cpanm Test::Perl::Critic
    $ sudo cpanm Test::Check::Manifest
    $ export TEST_AUTHOR=1
    $ prove -l t/


How to cut a release
--------------------

First, clone the ``smithfarm/dochazka.git`` repo::

    $ git clone https://github.com/smithfarm/dochazka.git
    $ cd dochazka

From there, follow the instructions at
https://github.com/smithfarm/dochazka#release-management