-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathREADME
84 lines (57 loc) · 4.11 KB
/
README
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
79
80
81
82
83
BVA-KALE
Extensible user interface
KALE is an evolution from a private set of modules under the BVA::XUI namespace.
BVA::XUI provides a versatile means of collecting, storing, and presenting information.
XUI objects are capable of requesting and accepting input from files, std input, http, and customizable modes.
XUI objects can provide outputs in std output, text files, Excel workbooks, html, json, pdf, rtf, and customizable formats.
BVA::XUI has been in use only in private installations, in some Internet website back-ends and in some data analysis libraries.
BVA::XUI has been in continuous develeopment beginning in 2001; the version on GitHub initially is 3.6_001, dated 2013-03-31. I will be committing several changes soon reflecting further development through 2013.
The KALE project seeks to bring XUI up to current standards for publication as open source. The work entails:
- Bring the code base to current best practices;
- Add flexible use of newer Perl version capabilities where available;
- Convert comments and separate instruction files to POD;
- Convert "sanity checks" and separate test scripts to standard suite of tests;
- Assemble KALE distribution for CPAN.
KALE takes its name from the kale (kohl) family of plants (the Brassicas), so many of which provide nourishment to people around the world - cabbage, broccoli, kale, collard greens, cauliflower, brussels sprouts, kohlrabi. Each of these is a variation on the same basic plant, but each one extends its growth and stores its energy in a unique part of the plant's structure. Cauliflower tops short stems with massive flowers, broccoli has longer stems and still lots of storage in the flower; cabbage no stems, everything in the tightly nested leaves. That's the idea of the KALE module: the basic system works fine, and it has many parts you can expand as needed for your application.
[This description will be expanded as I bring in the documentation.]
INSTALLATION
To install this module, run the following commands:
perl Build.PL
./Build
./Build test
./Build install
SUPPORT AND DOCUMENTATION
After installing, you can find documentation for this module with the
perldoc command.
perldoc BVA::KALE
LICENSE AND COPYRIGHT
Copyright (C) 2014 Bruce W Van Allen
This program is free software; you can redistribute it and/or modify it
under the terms of the the Artistic License (2.0). You may obtain a
copy of the full license at:
L<http://www.perlfoundation.org/artistic_license_2_0>
Any use, modification, and distribution of the Standard or Modified
Versions is governed by this Artistic License. By using, modifying or
distributing the Package, you accept this license. Do not use, modify,
or distribute the Package, if you do not accept this license.
If your Modified Version has been derived from a Modified Version made
by someone other than you, you are nevertheless required to ensure that
your Modified Version complies with the requirements of this license.
This license does not grant you the right to use any trademark, service
mark, tradename, or logo of the Copyright Holder.
This license includes the non-exclusive, worldwide, free-of-charge
patent license to make, have made, use, offer to sell, sell, import and
otherwise transfer the Package with respect to any patent claims
licensable by the Copyright Holder that are necessarily infringed by the
Package. If you institute patent litigation (including a cross-claim or
counterclaim) against any party alleging that the Package constitutes
direct or contributory patent infringement, then this Artistic License
to you shall terminate on the date that such litigation is filed.
Disclaimer of Warranty: THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER
AND CONTRIBUTORS "AS IS' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES.
THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY
YOUR LOCAL LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR
CONTRIBUTOR WILL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR
CONSEQUENTIAL DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE,
EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.