Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 112 lines (78 sloc) 3.387 kb
f022983 @rcaputo Initial revision
authored
1 $Id$
2
324b184 @rcaputo revise for imminent 0.1702 release
authored
3 --------------------
4 Detailed Information
5 --------------------
6
7 POE is bigger than this README. Please see http://poe.perl.org/ for
8 much more information.
9
6221c66 @rcaputo revise README
authored
10 -----------
11 What POE Is
12 -----------
53cd540 @rcaputo explained more about what the hell this is
authored
13
cb1142b @rcaputo Bring it up to date with what's going on.
authored
14 POE is a mature framework for creating networking or multitasking
15 programs in Perl. It has been in active, open development since
16 August 1998. It has been used in mission-critical systems such as
17 internetworked financial markets, file systems, commerce and
18 application servers. It has been used in projects ranging from a few
19 lines to nearly 20,000.
324b184 @rcaputo revise for imminent 0.1702 release
authored
20
21 POE is compatible with perl 5.005_03 through 5.6.1 and beyond.
22
23 POE includes functions for creating and using components. Components
24 are modular, reusable pieces of programs. Several components have
d41c89d @rcaputo Final preparations for releasing POE 0.20.
authored
25 been published on the CPAN, and more are listed on POE's web site.
324b184 @rcaputo revise for imminent 0.1702 release
authored
26
27 POE includes components and libraries for making quick work of network
cb1142b @rcaputo Bring it up to date with what's going on.
authored
28 clients, servers, and peers. A simple stand-alone web application
29 takes about 30 lines of code, most of which is your own custom logic.
1268917 @rcaputo reinvented it all again
authored
30
c377104 @rcaputo touch-up distribution files for Wheel::Run and pipes
authored
31 ---------------------
32 Documentation Roadmap
33 ---------------------
34
f1cac60 @rcaputo fix some minor typos
authored
35 POE includes so much documentation that the main man page includes an
cb1142b @rcaputo Bring it up to date with what's going on.
authored
36 index to the rest. See the "SEE ALSO" section in "man POE", or your
324b184 @rcaputo revise for imminent 0.1702 release
authored
37 system's equivalent.
c377104 @rcaputo touch-up distribution files for Wheel::Run and pipes
authored
38
cb1142b @rcaputo Bring it up to date with what's going on.
authored
39 The CHANGES file lists all the changes in the past year. POE's web
40 site includes a complete change history, broken down by release.
324b184 @rcaputo revise for imminent 0.1702 release
authored
41
42 --------------
43 Installing POE
44 --------------
670c4b3 @rcaputo tiny tweaks for next release
authored
45
d41c89d @rcaputo Final preparations for releasing POE 0.20.
authored
46 See http://poe.perl.org/?Where_to_Get_POE for download sites, Windows
47 tips, and anonymous CVS instructions.
1268917 @rcaputo reinvented it all again
authored
48
d8788af @rcaputo Big documentation rewrite
authored
49 POE may be installed through the CPAN shell in the usual CPAN shell
324b184 @rcaputo revise for imminent 0.1702 release
authored
50 manner.
1268917 @rcaputo reinvented it all again
authored
51
d8788af @rcaputo Big documentation rewrite
authored
52 perl -MCPAN -e 'install POE'
1268917 @rcaputo reinvented it all again
authored
53
d8788af @rcaputo Big documentation rewrite
authored
54 It involves a little more work if you have an older CPAN shell:
1268917 @rcaputo reinvented it all again
authored
55
d8788af @rcaputo Big documentation rewrite
authored
56 perl -MCPAN -e shell
d41c89d @rcaputo Final preparations for releasing POE 0.20.
authored
57 cpan> install POE
1268917 @rcaputo reinvented it all again
authored
58
cb1142b @rcaputo Bring it up to date with what's going on.
authored
59 To install on a Win32 machine using ActiveState's PPM. If PPM fails,
60 try PPM3:
6221c66 @rcaputo revise README
authored
61
cb1142b @rcaputo Bring it up to date with what's going on.
authored
62 ppm install http://unc.dl.sourceforge.net/sourceforge/poe/POE.ppd
63 ppm3 install http://unc.dl.sourceforge.net/sourceforge/poe/POE.ppd
f2789c3 @rcaputo updated documentation for new contributions
authored
64
5225b6b @rcaputo readme fixes
authored
65 ------------
66 Test Results
67 ------------
1db9198 @rcaputo lots of testing changes and additions
authored
68
e445966 @rcaputo Last minute tweaks.
authored
69 POE's test results are large and constantly changing, so it makes more
70 sense that they are on the web.
324b184 @rcaputo revise for imminent 0.1702 release
authored
71
f512910 @sungo document the test server and the makefile targets
sungo authored
72 http://eekeek.org/poe-tests/
e445966 @rcaputo Last minute tweaks.
authored
73 -- Automated test reports by users like you.
74
d41c89d @rcaputo Final preparations for releasing POE 0.20.
authored
75 http://testers.cpan.org/search?request=dist&dist=POE
e445966 @rcaputo Last minute tweaks.
authored
76 -- CPAN testers' reports.
77
78 POE's ongoing improvement relies on your feedback. The easiest way to
79 do that is included in the POE distribution itself. The Makefile
80 includes two targets: 'testreport' and 'reportupload'.
81
82 make testreport
83 make reportupload
84
85 Running 'make testreport' will run the test suite and generate an XML
86 file summarizing the test results named 'poe_report.xml'. If you have
87 an active non-proxied internet connection, running 'make reportupload'
88 will transmit your test results to the POE test server.
89
71ab3b1 @rcaputo Remove the link to the deprecated stinky hand-maintained test results.
authored
90 If 'make reportupload' fails, you can upload poe_report.xml from the
91 form at http://eekeek.org/poe-tests/ .
d41c89d @rcaputo Final preparations for releasing POE 0.20.
authored
92
e445966 @rcaputo Last minute tweaks.
authored
93 Uploaded test results can be viewed at http://eekeek.org/poe-tests/.
c5c96e7 @rcaputo partial pty code in wheel::run... need to move to another machine
authored
94
a710504 @rcaputo Tweak README and Makefile.PL
authored
95 -------------
96 Test Coverage
97 -------------
98
324b184 @rcaputo revise for imminent 0.1702 release
authored
99 POE's test coverage report has also moved onto the 'web. It gives a
100 very rough idea of the amount of POE that's been at least cursorily
101 tested, but it should not be used as an accurate gauge of quality.
4a6ecea @rcaputo move unessential information to the web
authored
102
d41c89d @rcaputo Final preparations for releasing POE 0.20.
authored
103 http://poe.perl.org/?POE%27s_test_coverage_report
104
4a6ecea @rcaputo move unessential information to the web
authored
105 ----
106 Bye!
107 ----
f2789c3 @rcaputo updated documentation for new contributions
authored
108
ad3be79 @rcaputo gtk debugged... moving to os/2 for testing
authored
109 Thanks for reading!
0d6f19d @rcaputo Revised all the manpages. Split the manpages into separate PODs, and
authored
110
324b184 @rcaputo revise for imminent 0.1702 release
authored
111 -- Rocco Caputo / rcaputo@cpan.org / poe.perl.org / poe.sourceforge.net
Something went wrong with that request. Please try again.