forked from halostatue-archive/text-reform
/
README
49 lines (30 loc) · 1.28 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
= text-reform
http://github.com/kschiess/text-reform/
== DESCRIPTION:
Text::Reform reformats text according to formatting picture templates. It's a
port from the Perl module of the same name originally by Damian Conway
(damian@conway.org). Much of the documentation has been copied from the
original documentation and adapted to the Ruby version.
The interface is subject to change, since it will undergo major Rubyfication;
additionally, some features may have not been ported yet.
== SYNOPSIS:
require 'text/reform'
f = Text::Reform.new
puts f.format(template, data)
== REQUIREMENTS:
* FIX (list of requirements)
== FUTURE ENHANCEMENTS:
* For page header and footer, if you mix :center, :left and :right in the same
hash, only one of them will get used. It would be nice if those were
combined.
== INSTALL:
* This release of text-reform is only installed with RubyGems.
== DEVELOPERS:
After checking out the source, run:
$ rake newb
This task will install any missing dependencies, run the tests/specs,
and generate the RDoc.
== LICENSE:
Copyright (c) 2005, Kaspar Schiess. All Rights Reserved. This module is free
software. It may be used, redistributed and/or modified under the terms of the
Ruby License (see http://www.ruby-lang.org/en/LICENSE.txt) or the MIT License.