Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse code

revise for imminent 0.1702 release

  • Loading branch information...
commit 324b18472567eee17b08a6b604625e426f0d47b9 1 parent 1b3af90
Rocco Caputo authored

Showing 1 changed file with 57 additions and 101 deletions. Show diff stats Hide diff stats

  1. +57 101 README
158 README
... ... @@ -1,52 +1,68 @@
1 1 $Id$
2 2
  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 +
3 10 -----------
4 11 What POE Is
5 12 -----------
6 13
7   -POE is an application kernel that uses event driven state machines as
8   -threads. It includes a high-level I/O library that hides most of the
9   -usual client/server tediosity. It has been developed and used in
10   -mission-critical systems since August 1998.
  14 +POE is a mature framework for creating multitasking programs in Perl.
  15 +It has been actively developed for over three years. It has been used
  16 +in mission-critical systems such as internetworked financial markets,
  17 +filesystems, and commerce servers.
  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
  23 +been published on the CPAN.
  24 +
  25 +POE includes components and libraries for making quick work of network
  26 +clients, servers, and peers. A well "hello, world" web application
  27 +takes fewer than 50 lines of code.
11 28
12 29 ---------------------
13 30 Documentation Roadmap
14 31 ---------------------
15 32
16   -The POE manpage's SEE ALSO section lists the topics covered in each
17   -manpage. It's a good starting place.
  33 +POE includes so much documentation that the main manpage includes an
  34 +index to the others. See the "SEE ALSO" section in "man POE", or your
  35 +system's equivalent.
18 36
19   -The CHANGES file lists all the changes in the past year. A more
20   -complete version is available at <http://poe.perl.org/?POE_CHANGES>.
21   -This file highlights changes that may break existing programs.
  37 +The CHANGES file lists all the changes in the past year. Changes back
  38 +to August 1998 are available on the web.
22 39
23 40 --------------------
24 41 Distribution Details
25 42 --------------------
26 43
27   -This distribution comes with several sample and tutorial programs in
28   -its samples/ directory. These programs are NOT installed because they
29   -have limited use and take up a lot of space.
  44 +This distribution includes several sample and tutorial programs. They
  45 +are in the "samples" directory. These programs take up a considerable
  46 +chunk of POE's download size, but they are NOT installed.
30 47
31   -The lib/ directory includes a few useful utilities, including a basic
32   -test coverage module, harness, and report. The test coverage summary
33   -at the end of this file was generated by that system. These utilities
34   -aren't installed either.
35   -
36   -The test programs, in t/, may also be interesting examples, although
37   -they're more geared towards exercising POE. The tests also aren't
38   -installed, in case you were wondering.
  48 +The test programs, in directory "t", may also be interesting examples,
  49 +but they're aimed more at exercising POE than illustrating good coding
  50 +practices. The tests also aren't installed, in case you were
  51 +wondering.
39 52
40 53 All in all, the actual installed bits of POE are probably around a
41 54 third of the total distribution, and about a quarter of B<that> is
42   -documentation. The generally usable bits of POE are pretty small.
  55 +documentation. Most of the installed code is optional, so the parts
  56 +of POE people usually use tend to be relatively small.
  57 +
  58 +--------------
  59 +Installing POE
  60 +--------------
43 61
44   -------------------
45   -Basic Installation
46   -------------------
  62 +See http://poe.perl.org/?Where_to_Get_POE for complete instructions.
47 63
48 64 POE may be installed through the CPAN shell in the usual CPAN shell
49   -manner. It typically is:
  65 +manner.
50 66
51 67 perl -MCPAN -e 'install POE'
52 68
@@ -58,93 +74,33 @@ It involves a little more work if you have an older CPAN shell:
58 74 To install on a Win32 machine using ActiveState's PPM:
59 75
60 76 ppm install http://poe.sourceforge.net/packages/POE.ppd
61   -
62   ---------------------------
63   -Getting The Latest Version
64   ---------------------------
65   -
66   -POE can also be installed manually, although Win32 users are
67   -recommended to use the PPM instead. Tarballs are available from at
68   -least three sources:
69   -
70   -The most recent stable release can be found at your favorite CPAN
71   -mirror. If you don't have a favorite CPAN mirror, there's always:
72   -
73   - ftp://ftp.cpan.org/pub/CPAN/authors/id/R/RC/RCAPUTO/
74   -
75   -The most recent development snapshot is available from two locations:
76   -
77   - http://poe.perl.org/
78   - http://sourceforge.net/projects/poe/
79   -
80   -The SourceForge project includes a CVS repository browser, so you can
81   -look around to see what's new. It also has facilities for people to
82   -submit bug reports, patches, and support requests.
83   -
84   ----------------------------
85   -Building The Latest Version
86   ----------------------------
87   -
88   -Downloading and unpacking the distribution are left as an exercise for
89   -the reader. See the previous section for tarball locations.
90 77
91   -System requirements and copatibility issues are covered in the main
92   -POE manpage. You can preview them before building POE.
93   -
94   - perldoc ./POE.pm
95   -
96   -Please read the CHANGES file if you already have programs which use
97   -POE. It contains advance notice of changes which may break existing
98   -code. POE's change history is at <http://poe.perl.org/?POE_CHANGES>,
99   -and a copy is provided in the distribution.
100   -
101   - less ./CHANGES
102   -
103   -If everything looks good, build POE:
104   -
105   - perl Makefile.PL
106   - make
107   -
108   -... then test the distribution. The test suite includes a dependency
109   -report. Please read it carefully if POE won't build.
110   -
111   - make test
112   -
113   -Now you're ready to install POE, but first you may want to look at its
114   -samples. Some of the samples may be stale: they might not work with
115   -the most recent distribution, but everything is okay as long as "make
116   -test" has passed.
117   -
118   -All the programs in the samples subdirectory are written to run from
119   -the distribution directory without POE being installed yet.
120   -
121   - cd ./samples
122   - ls -l
123   -
124   - [try some]
125   -
126   - cd ..
127   -
128   -Finally you can install it:
129   -
130   - make install
  78 +POE can also be installed manually, and the latest versions of things
  79 +are available in CVS. Instructions are on POE's web site.
131 80
132 81 ------------
133 82 Test Results
134 83 ------------
135 84
136   -POE's test results have moved onto the 'web. You can find them at
137   -<http://poe.perl.org/?POE%27s_test_results>.
  85 +http://poe.perl.org/?POE%27s_test_results
138 86
139   -If you have tested POE on a configuration that's not listed there,
140   -please consider adding your results to the site. Thanks!
  87 +POE's test results are large and constantly changing. They have been
  88 +moved to the web site for easier maintenance. POE is tested severely
  89 +before even the limited-distribution development releases.
  90 +
  91 +In the unlikely event that POE's tests fail, please consider reporting
  92 +the failure. Open source has always relied on the kindness of
  93 +strangers.
141 94
142 95 -------------
143 96 Test Coverage
144 97 -------------
145 98
146   -POE's test coverage report has also moved onto the 'web. It's at
147   -<http://poe.perl.org/?POE%27s_test_coverage_report>.
  99 +http://poe.perl.org/?POE%27s_test_coverage_report
  100 +
  101 +POE's test coverage report has also moved onto the 'web. It gives a
  102 +very rough idea of the amount of POE that's been at least cursorily
  103 +tested, but it should not be used as an accurate gauge of quality.
148 104
149 105 ----
150 106 Bye!
@@ -152,4 +108,4 @@ Bye!
152 108
153 109 Thanks for reading!
154 110
155   --- Rocco Caputo / troc@netrus.net / poe.perl.org / poe.sourceforge.net
  111 +-- Rocco Caputo / rcaputo@cpan.org / poe.perl.org / poe.sourceforge.net

0 comments on commit 324b184

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