Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse code

Updated the README.

Fix formatting, a wrong expansion of the SVG acronym and other stuff.
  • Loading branch information...
commit 7d61e3708227c2ad84eecae69dbf65266311e21a 1 parent 2842222
Shlomi Fish authored April 22, 2012

Showing 1 changed file with 40 additions and 21 deletions. Show diff stats Hide diff stats

  1. 61  README
61  README
... ...
@@ -1,16 +1,16 @@
1 1
 README for SVG.pm
2 2
 
3 3
 SVG.pm is a perl extention to generate standalone or inline SVG 
4  
-(scaleable vector graphics) images using the W3C SVG xml recommendation.
  4
+(short for "Scalable Vector Graphics") images using the W3C's
  5
+SVG XML recommendation.
5 6
 
6  
-Refer to the pod for full documentation and an example script, 
7  
-or to the following mirrors:
  7
+Refer to the POD documentation for full documentation and an example
  8
+script, or to the following mirror:
8 9
 
9  
-1/ http://search.cpan.org/perldoc?SVG
10  
-2/ http://search.cpan.org/~ronan
  10
+    https://metacpan.org/module/SVG
11 11
 
12  
-The complete pod for SVG resides in SVG::Manual 
13  
-type perldoc SVG::Manual on the command line
  12
+The complete POD documentation for SVG resides in SVG::Manual -
  13
+type "perldoc SVG::Manual" on the command line.
14 14
 
15 15
 (c) 2001-2008  Ronan Oger, RO IT Systems, GmbH  
16 16
 homepage: http://www.roitsystems.com
@@ -18,7 +18,7 @@ homepage: http://www.roitsystems.com
18 18
 CONTACT POINT
19 19
 -------------
20 20
 
21  
-ronan@cpan.org
  21
+szabgab@cpan.org
22 22
 
23 23
 This software is provided as is and without warranty. 
24 24
 It is freely distributed under the general perl license.
@@ -30,47 +30,59 @@ This software is provided under the terms of the Perl license
30 30
 
31 31
 OVERVIEW
32 32
 --------
  33
+
33 34
 SVG.pm makes it possible to generate fully-functional SVG images in perl.
34 35
 100% of the SVG tags are supported, and any new arbitrary element tag can be
35 36
 added by users by declaring it.
36 37
 
37 38
 VERSION
38 39
 -------
  40
+
39 41
 2.33 Sunday, 2005.05.15
40 42
 
41 43
 DOCUMENTATION
42 44
 -------------
  45
+
43 46
 The following documentation is available:
44  
-POD in HTML format
45  
-pod in perldoc format (type perldoc SVG on command line)
  47
+
  48
+* POD in HTML format.
  49
+* POD in perldoc format (type "perldoc SVG" on the command line.)
46 50
 
47 51
 RESOURCES
48 52
 ---------
  53
+
49 54
 The following URLs offer additional resources for users of SVG.pm:
  55
+
50 56
 * Serverside Perl Forum: http://www.roitsystems.com/serverside/
51 57
 * SVG.pm on-line manual http://www.roitsystems.com/man/SVG.html
52 58
 * Perl SVG tutorials http://www.roitsystems.com/tutorial/
53 59
 * Perl SVG Zone homepage http://www.roitsystems.com/
54  
-* gallery of the use of SVG.pm on the web http://roitsystems.com/gallery/svg/index.html 
55  
-* SVG Foundation http://www.svgfoundation.org
  60
+* gallery of the use of SVG.pm on the web http://roitsystems.com/gallery/svg/index.html
  61
+* SVG Foundation http://www.svgfoundation.org/
56 62
 * SVG Developers mailing list http://www.yahoogroups.com/svg-developers/
57  
-* W3 Consortium http://www.w3.org
  63
+* W3 Consortium http://www.w3.org/
58 64
 * Sams Publishing, "SVG Unleashed", September 2002. There is a Perl chapter
59  
-* SVG Open Conference proceedings http://www.svgopen.org
60  
-* SVG foundation http://www.svgfoundation.org
61  
-* SVG dot org http://www.svg.org
  65
+* SVG Open Conference proceedings http://www.svgopen.org/
  66
+* SVG foundation http://www.svgfoundation.org/
  67
+* SVG dot org http://www.svg.org/
  68
+
62 69
 INSTALLATION INSTRUCTIONS
63 70
 -------------------------
64  
-***THERE ARE FIVE WAYS TO IMPLEMENT SVG MODULE IN PERL***
  71
+
  72
+***THERE ARE FIVE WAYS TO INSTALL THE SVG MODULE IN PERL***
65 73
 
66 74
 	1/ Systems with CPAN support (all Unix/Linux/BSD/Mac):
67 75
 	-----------------------------------------------------
  76
+
68 77
 	Install the new distribution via the Perl CPAN module:
69 78
 	In a shell:
70 79
 	/home/somewhere% perl -MCPAN -e"install SVG"
71 80
 
  81
+    You can alternatively use CPANPLUS or cpanm.
  82
+
72 83
 	2/ (WIN) install Perl from Active State or equivalent:
73 84
 	-----------------------------------------------------
  85
+
74 86
 	Make sure you already have perl or get it here: http://www.activestate.com
75 87
 	On the command line:
76 88
 	 C:\> ppm
@@ -80,6 +92,8 @@ INSTALLATION INSTRUCTIONS
80 92
 	 C:\>
81 93
 
82 94
 	3/ Use Source RPMs.
  95
+    -------------------
  96
+
83 97
 	Download the source RPM of your choice.
84 98
 	In a shell:
85 99
 	/hom/somewhere/% rpm -ihv SVG-source-rpm-name
@@ -87,10 +101,9 @@ INSTALLATION INSTRUCTIONS
87 101
 
88 102
 	4/ The hard way (requires make or nmake, tar, gunzip, and gcc):
89 103
 	---------------------------------------------------------------
  104
+
90 105
 	This method was tested in DOS, Windows, AS400, Linux, Unix, BSD, Mac.
91  
-	Hard-headed users can directly get the distribution from 
92  
-	http://www.roitsystems.com/PPM/SVG/SVG-2.27.tar.gz or 
93  
-	http://www.roitsystems.com/PPM/SVG/ .
  106
+	Hard-headed users can directly get the distribution from a CPAN mirror.
94 107
 	First download the source.
95 108
 	Then, in a shell:
96 109
 	/home/somewhere% gunzip SVG-2.27.tar.gz
@@ -103,6 +116,7 @@ INSTALLATION INSTRUCTIONS
103 116
 
104 117
 	5/ If all the above fail, there is still a (cumbersome) way:
105 118
 	-----------------------------------------------------------
  119
+
106 120
 	You have to install to a local dirctory and explicitly call the module 
107 121
 	by using one of the following line in your calling program:
108 122
 
@@ -121,12 +135,15 @@ INSTALLATION INSTRUCTIONS
121 135
 
122 136
 KNOWN BUGS & ISSUES
123 137
 -------------------
124  
-Comments tags before the <svg> element are toxic. This is being worked on but I can not promise anything.
  138
+
  139
+Comments tags before the <svg> element are toxic. This is being worked on but I
  140
+can not promise anything.
125 141
 
126 142
 Please submit bug reports to http://rt.cpan.org
127 143
 
128 144
 SEE ALSO
129 145
 --------
  146
+
130 147
 SVG::Parser
131 148
 SVG::DOM
132 149
 SVG::XML
@@ -134,10 +151,12 @@ SVG::Element
134 151
 
135 152
 CHANGE LOG
136 153
 ----------
  154
+
137 155
 You can find details about the changes over time in the change log file: Changes
138 156
 
139 157
 COMMENTS/FEEDBACK
140 158
 -----------------
  159
+
141 160
 Please email your feedback, comments, questions to the email address at the top
142 161
 of this document. I will do my best to answer promptly. To date, I have not
143 162
 knowingly failed to answer any emails.

0 notes on commit 7d61e37

Please sign in to comment.
Something went wrong with that request. Please try again.