Skip to content
Browse files

revise for imminent 0.1702 release

  • Loading branch information...
1 parent 1b3af90 commit 324b18472567eee17b08a6b604625e426f0d47b9 @rcaputo committed Jan 3, 2002
Showing with 57 additions and 101 deletions.
  1. +57 −101 README
View
158 README
@@ -1,52 +1,68 @@
$Id$
+--------------------
+Detailed Information
+--------------------
+
+POE is bigger than this README. Please see http://poe.perl.org/ for
+much more information.
+
-----------
What POE Is
-----------
-POE is an application kernel that uses event driven state machines as
-threads. It includes a high-level I/O library that hides most of the
-usual client/server tediosity. It has been developed and used in
-mission-critical systems since August 1998.
+POE is a mature framework for creating multitasking programs in Perl.
+It has been actively developed for over three years. It has been used
+in mission-critical systems such as internetworked financial markets,
+filesystems, and commerce servers.
+
+POE is compatible with perl 5.005_03 through 5.6.1 and beyond.
+
+POE includes functions for creating and using components. Components
+are modular, reusable pieces of programs. Several components have
+been published on the CPAN.
+
+POE includes components and libraries for making quick work of network
+clients, servers, and peers. A well "hello, world" web application
+takes fewer than 50 lines of code.
---------------------
Documentation Roadmap
---------------------
-The POE manpage's SEE ALSO section lists the topics covered in each
-manpage. It's a good starting place.
+POE includes so much documentation that the main manpage includes an
+index to the others. See the "SEE ALSO" section in "man POE", or your
+system's equivalent.
-The CHANGES file lists all the changes in the past year. A more
-complete version is available at <http://poe.perl.org/?POE_CHANGES>.
-This file highlights changes that may break existing programs.
+The CHANGES file lists all the changes in the past year. Changes back
+to August 1998 are available on the web.
--------------------
Distribution Details
--------------------
-This distribution comes with several sample and tutorial programs in
-its samples/ directory. These programs are NOT installed because they
-have limited use and take up a lot of space.
+This distribution includes several sample and tutorial programs. They
+are in the "samples" directory. These programs take up a considerable
+chunk of POE's download size, but they are NOT installed.
-The lib/ directory includes a few useful utilities, including a basic
-test coverage module, harness, and report. The test coverage summary
-at the end of this file was generated by that system. These utilities
-aren't installed either.
-
-The test programs, in t/, may also be interesting examples, although
-they're more geared towards exercising POE. The tests also aren't
-installed, in case you were wondering.
+The test programs, in directory "t", may also be interesting examples,
+but they're aimed more at exercising POE than illustrating good coding
+practices. The tests also aren't installed, in case you were
+wondering.
All in all, the actual installed bits of POE are probably around a
third of the total distribution, and about a quarter of B<that> is
-documentation. The generally usable bits of POE are pretty small.
+documentation. Most of the installed code is optional, so the parts
+of POE people usually use tend to be relatively small.
+
+--------------
+Installing POE
+--------------
-------------------
-Basic Installation
-------------------
+See http://poe.perl.org/?Where_to_Get_POE for complete instructions.
POE may be installed through the CPAN shell in the usual CPAN shell
-manner. It typically is:
+manner.
perl -MCPAN -e 'install POE'
@@ -58,98 +74,38 @@ It involves a little more work if you have an older CPAN shell:
To install on a Win32 machine using ActiveState's PPM:
ppm install http://poe.sourceforge.net/packages/POE.ppd
-
---------------------------
-Getting The Latest Version
---------------------------
-
-POE can also be installed manually, although Win32 users are
-recommended to use the PPM instead. Tarballs are available from at
-least three sources:
-
-The most recent stable release can be found at your favorite CPAN
-mirror. If you don't have a favorite CPAN mirror, there's always:
-
- ftp://ftp.cpan.org/pub/CPAN/authors/id/R/RC/RCAPUTO/
-
-The most recent development snapshot is available from two locations:
-
- http://poe.perl.org/
- http://sourceforge.net/projects/poe/
-
-The SourceForge project includes a CVS repository browser, so you can
-look around to see what's new. It also has facilities for people to
-submit bug reports, patches, and support requests.
-
----------------------------
-Building The Latest Version
----------------------------
-
-Downloading and unpacking the distribution are left as an exercise for
-the reader. See the previous section for tarball locations.
-System requirements and copatibility issues are covered in the main
-POE manpage. You can preview them before building POE.
-
- perldoc ./POE.pm
-
-Please read the CHANGES file if you already have programs which use
-POE. It contains advance notice of changes which may break existing
-code. POE's change history is at <http://poe.perl.org/?POE_CHANGES>,
-and a copy is provided in the distribution.
-
- less ./CHANGES
-
-If everything looks good, build POE:
-
- perl Makefile.PL
- make
-
-... then test the distribution. The test suite includes a dependency
-report. Please read it carefully if POE won't build.
-
- make test
-
-Now you're ready to install POE, but first you may want to look at its
-samples. Some of the samples may be stale: they might not work with
-the most recent distribution, but everything is okay as long as "make
-test" has passed.
-
-All the programs in the samples subdirectory are written to run from
-the distribution directory without POE being installed yet.
-
- cd ./samples
- ls -l
-
- [try some]
-
- cd ..
-
-Finally you can install it:
-
- make install
+POE can also be installed manually, and the latest versions of things
+are available in CVS. Instructions are on POE's web site.
------------
Test Results
------------
-POE's test results have moved onto the 'web. You can find them at
-<http://poe.perl.org/?POE%27s_test_results>.
+http://poe.perl.org/?POE%27s_test_results
-If you have tested POE on a configuration that's not listed there,
-please consider adding your results to the site. Thanks!
+POE's test results are large and constantly changing. They have been
+moved to the web site for easier maintenance. POE is tested severely
+before even the limited-distribution development releases.
+
+In the unlikely event that POE's tests fail, please consider reporting
+the failure. Open source has always relied on the kindness of
+strangers.
-------------
Test Coverage
-------------
-POE's test coverage report has also moved onto the 'web. It's at
-<http://poe.perl.org/?POE%27s_test_coverage_report>.
+http://poe.perl.org/?POE%27s_test_coverage_report
+
+POE's test coverage report has also moved onto the 'web. It gives a
+very rough idea of the amount of POE that's been at least cursorily
+tested, but it should not be used as an accurate gauge of quality.
----
Bye!
----
Thanks for reading!
--- Rocco Caputo / troc@netrus.net / poe.perl.org / poe.sourceforge.net
+-- 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.