Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 131 lines (91 sloc) 4.063 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
324b184 @rcaputo revise for imminent 0.1702 release
authored
14 POE is a mature framework for creating multitasking programs in Perl.
d41c89d @rcaputo Final preparations for releasing POE 0.20.
authored
15 It has been in active development since 1998. It has been used in
16 mission-critical systems such as internetworked financial markets,
17 file systems, commerce and application servers.
324b184 @rcaputo revise for imminent 0.1702 release
authored
18
19 POE is compatible with perl 5.005_03 through 5.6.1 and beyond.
20
21 POE includes functions for creating and using components. Components
22 are modular, reusable pieces of programs. Several components have
d41c89d @rcaputo Final preparations for releasing POE 0.20.
authored
23 been published on the CPAN, and more are listed on POE's web site.
324b184 @rcaputo revise for imminent 0.1702 release
authored
24
25 POE includes components and libraries for making quick work of network
d41c89d @rcaputo Final preparations for releasing POE 0.20.
authored
26 clients, servers, and peers. A "hello, world" web application takes
27 fewer than 50 lines of code, most of which is configuration.
1268917 @rcaputo reinvented it all again
authored
28
c377104 @rcaputo touch-up distribution files for Wheel::Run and pipes
authored
29 ---------------------
30 Documentation Roadmap
31 ---------------------
32
f1cac60 @rcaputo fix some minor typos
authored
33 POE includes so much documentation that the main man page includes an
324b184 @rcaputo revise for imminent 0.1702 release
authored
34 index to the others. See the "SEE ALSO" section in "man POE", or your
35 system's equivalent.
c377104 @rcaputo touch-up distribution files for Wheel::Run and pipes
authored
36
d41c89d @rcaputo Final preparations for releasing POE 0.20.
authored
37 The CHANGES file lists all the changes in the past year. A complete
38 change history, back to August 1998, is available on POE's web site.
7d83cbb @rcaputo document CHANGES and TODO
authored
39
670c4b3 @rcaputo tiny tweaks for next release
authored
40 --------------------
41 Distribution Details
42 --------------------
43
d41c89d @rcaputo Final preparations for releasing POE 0.20.
authored
44 This distribution includes a samples directory that contains several
45 well commented example programs. These programs are NOT installed.
46 Better examples are being written all the time and are available
47 online in the POE Cookbook.
670c4b3 @rcaputo tiny tweaks for next release
authored
48
d41c89d @rcaputo Final preparations for releasing POE 0.20.
authored
49 POE's test programs may also be interesting examples, but they're more
50 for exercising POE than illustrating good coding practices. The tests
51 also aren't installed, in case you were wondering.
670c4b3 @rcaputo tiny tweaks for next release
authored
52
53 All in all, the actual installed bits of POE are probably around a
d41c89d @rcaputo Final preparations for releasing POE 0.20.
authored
54 third of the total distribution, and about a quarter of POE's
55 installed footprint is documentation.
324b184 @rcaputo revise for imminent 0.1702 release
authored
56
57 --------------
58 Installing POE
59 --------------
670c4b3 @rcaputo tiny tweaks for next release
authored
60
d41c89d @rcaputo Final preparations for releasing POE 0.20.
authored
61 See http://poe.perl.org/?Where_to_Get_POE for download sites, Windows
62 tips, and anonymous CVS instructions.
1268917 @rcaputo reinvented it all again
authored
63
d8788af @rcaputo Big documentation rewrite
authored
64 POE may be installed through the CPAN shell in the usual CPAN shell
324b184 @rcaputo revise for imminent 0.1702 release
authored
65 manner.
1268917 @rcaputo reinvented it all again
authored
66
d8788af @rcaputo Big documentation rewrite
authored
67 perl -MCPAN -e 'install POE'
1268917 @rcaputo reinvented it all again
authored
68
d8788af @rcaputo Big documentation rewrite
authored
69 It involves a little more work if you have an older CPAN shell:
1268917 @rcaputo reinvented it all again
authored
70
d8788af @rcaputo Big documentation rewrite
authored
71 perl -MCPAN -e shell
d41c89d @rcaputo Final preparations for releasing POE 0.20.
authored
72 cpan> install POE
1268917 @rcaputo reinvented it all again
authored
73
872a639 @rcaputo documented AS PPM install
authored
74 To install on a Win32 machine using ActiveState's PPM:
75
76 ppm install http://poe.sourceforge.net/packages/POE.ppd
6221c66 @rcaputo revise README
authored
77
324b184 @rcaputo revise for imminent 0.1702 release
authored
78 POE can also be installed manually, and the latest versions of things
d41c89d @rcaputo Final preparations for releasing POE 0.20.
authored
79 are available in CVS.
f2789c3 @rcaputo updated documentation for new contributions
authored
80
5225b6b @rcaputo readme fixes
authored
81 ------------
82 Test Results
83 ------------
1db9198 @rcaputo lots of testing changes and additions
authored
84
e445966 @rcaputo Last minute tweaks.
authored
85 POE's test results are large and constantly changing, so it makes more
86 sense that they are on the web.
324b184 @rcaputo revise for imminent 0.1702 release
authored
87
f512910 @sungo document the test server and the makefile targets
sungo authored
88 http://eekeek.org/poe-tests/
e445966 @rcaputo Last minute tweaks.
authored
89 -- Automated test reports by users like you.
90
d41c89d @rcaputo Final preparations for releasing POE 0.20.
authored
91 http://poe.perl.org/?POE%27s_test_results
e445966 @rcaputo Last minute tweaks.
authored
92 -- Manually maintained test reports, also by users like you.
93
d41c89d @rcaputo Final preparations for releasing POE 0.20.
authored
94 http://testers.cpan.org/search?request=dist&dist=POE
e445966 @rcaputo Last minute tweaks.
authored
95 -- CPAN testers' reports.
96
97 POE's ongoing improvement relies on your feedback. The easiest way to
98 do that is included in the POE distribution itself. The Makefile
99 includes two targets: 'testreport' and 'reportupload'.
100
101 make testreport
102 make reportupload
103
104 Running 'make testreport' will run the test suite and generate an XML
105 file summarizing the test results named 'poe_report.xml'. If you have
106 an active non-proxied internet connection, running 'make reportupload'
107 will transmit your test results to the POE test server.
108
109 If 'make reportupload' fails, go to http://eekeek.org/poe-tests/ and
110 upload the poe_report.xml file using the form on that page.
d41c89d @rcaputo Final preparations for releasing POE 0.20.
authored
111
e445966 @rcaputo Last minute tweaks.
authored
112 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
113
a710504 @rcaputo Tweak README and Makefile.PL
authored
114 -------------
115 Test Coverage
116 -------------
117
324b184 @rcaputo revise for imminent 0.1702 release
authored
118 POE's test coverage report has also moved onto the 'web. It gives a
119 very rough idea of the amount of POE that's been at least cursorily
120 tested, but it should not be used as an accurate gauge of quality.
4a6ecea @rcaputo move unessential information to the web
authored
121
d41c89d @rcaputo Final preparations for releasing POE 0.20.
authored
122 http://poe.perl.org/?POE%27s_test_coverage_report
123
4a6ecea @rcaputo move unessential information to the web
authored
124 ----
125 Bye!
126 ----
f2789c3 @rcaputo updated documentation for new contributions
authored
127
ad3be79 @rcaputo gtk debugged... moving to os/2 for testing
authored
128 Thanks for reading!
0d6f19d @rcaputo Revised all the manpages. Split the manpages into separate PODs, and
authored
129
324b184 @rcaputo revise for imminent 0.1702 release
authored
130 -- Rocco Caputo / rcaputo@cpan.org / poe.perl.org / poe.sourceforge.net
Something went wrong with that request. Please try again.