Updated README.txt

git-svn-id: http://svn.pjsip.org/repos/pjproject/trunk@314 74dad513-b988-da41-8d7b-12977e46ad98

2 files changed, 63 insertions, 65 deletions

diff --git a/README.txt b/README.txt
index 646021e7..e4ee71dc 100644
--- a/README.txt
+++ b/README.txt
@@ -1,11 +1,70 @@
-PJPROJECT is released under GPL. License information can be found in file 
-COPYING in this directory. For alternative licensing, please contact the
-copyright holder.
 
 See INSTALL.txt for compiling.
 
-IMPORTANT:
+
+TOP LEVEL DIRECTORIES
+======================
+Below is the descriptions of the top-level directories:
+
+-root
+ -build..................... Makefiles includes, nothing interesting to see except
+                             when porting to new platforms.
+ -pjlib..................... Base library used by all other libraries.  It contains 
+                             platform abstraction, data structures, etc. 
+ -pjlib-util................ Utilities, such as text scanner, XML parser, etc.
+ -pjmedia................... Media framework, contains:
+                              - pjmedia.......... the core media framework, which 
+                                                  contains codec framework, streams,
+                                                  stream ports, conference bridge,
+                                                  RTP/RTCP, SDP, SDP negotiator, etc.
+                              - pjmedia-codec.... the static library container for 
+                                                  all codecs. For the moment, it
+                                                  contains GSM and SPEEX codec.
+ -pjsip..................... SIP stack, contains:
+                              - pjsip............ The core SIP stack, which contains
+                                                  endpoint, transport layer, message and
+                                                  URI structures, transaction layer, 
+                                                  UA layer and dialog, utilities, etc.
+                              - pjsip-simple..... SIMPLE (+presence, IM), contains
+                                                  basic event framework, presence, and
+                                                  instant messaging.
+                              - pjsip-ua......... SIP "call" abstraction, which blends
+                                                  INVITE session and SDP negotiation.
+                                                  Also contains call features such as
+                                                  call transfer, and client side SIP
+                                                  registration.
+                              - pjsua-lib........ Very high level UA app. library,
+                                                  which blends all functionalities
+                                                  together in very easy to use API.
+                                                  Good to build a powerfull softphone
+                                                  very quickly.
+ -pjsip-apps................ Contains some sample applications:
+                              - pjsua............ A powerful, console based SIP
+                                                  UA, based on pjsua-lib.
+                              - pjsip-perf....... SIP performance tester or call 
+                                                  generator.
+
+
+SUB-DIRECTORY LAYOUT
+======================
+Each subdirectories normally would have this layout:
+
+ -bin...................... The binaries resulted from the build process will
+                            go here.
+ -build.................... Makefile and project files.
+ -docs..................... Documentation specific to the project and doxygen config file
+                            to generate documentation from the source code.
+ -include.................. Header files.
+ -lib...................... The static libraries resulted from the build process
+                            will go here.
+ -src...................... Source files.
+
+
+YOUR EDITOR SETTINGS ARE IMPORTANT!
+====================================
 You need to set your editor settings to tab=8 and indent=4. For example,
 with vim, you can do this with:
  :se ts=8
  :se sts=4
+
+
diff --git a/docs/pjproject-0.2.8.html b/docs/pjproject-0.2.8.html
deleted file mode 100644
index 49acff88..00000000
--- a/docs/pjproject-0.2.8.html
+++ /dev/null
@@ -1,61 +0,0 @@
-<HTML>

-<HEAD>

-<TITLE>pjproject version 0.2.8</TITLE>

-</HEAD>

-<BODY>

-<strong>Version 0.2.8 - 2005/05/28</strong>

-<hr>

-<H3>Status</H3><P>

-- Should not crash when everything is ok. :)<BR>

-- All targets are up to date.</P>

-

-<H3>What's new</H3><P>

-- STUN client support (pj/stun*).<BR>

-- Briefly tested with&nbsp;iptel.org service&nbsp;(with or without STUN).<BR>

-- Removed PJSDP project (merged into PJMEDIA).<BR>

-- Changed I/O queue to use callback for more flexibility.</P>

-

-<P>For more information, go to <STRONG><A href="http://www.bulukucing.org/pjsip.html">PJSIP web page</A></STRONG> or <STRONG><A href="http://www.bulukucing.org/pjproject/v0.2.8/">Browse the Source Files</A></STRONG>.</P>

-

-<H3>Download source tar ball</H3>

-<P>

-<STRONG><A href="http://www.bulukucing.org/pjproject/v0.2.8/pjproject-0.2.8.tar.gz">pjproject-0.2.8.tar.gz</A></STRONG> (339KB)</P>

-

-<H3>Download executables</H3>

-<P>

-Win2k/XP (needs Direct Sound/msvcrt.dll, won't work on NT because of Direct Sound):<BR>

-- <A href="http://www.bulukucing.org/pjproject/v0.2.8/pjsua_vc6.exe"><STRONG>pjsua_vc6.exe</STRONG></A> (124 KB) or <A href="http://www.bulukucing.org/pjproject/v0.2.8/pjsua_vc6.exe.gz"><STRONG>pjsua_vc6.exe.gz</STRONG></A> (62 KB)</P>

-

-<P>Win32 mingw (no audio):<BR>

-- <A href="http://www.bulukucing.org/pjproject/v0.2.8/pjsua_mingw.exe"><STRONG>pjsua_mingw.exe</STRONG></A> (209 KB) or <A href="http://www.bulukucing.org/pjproject/v0.2.8/pjsua_mingw.exe.gz"><STRONG>pjsua_mingw.exe.gz</STRONG></A> (92 KB)</P>

-

-<P>Linux (compiled on Fedora Linux 3, no audio):<BR>

-- <A href="http://www.bulukucing.org/pjproject/v0.2.8/pjsua.gz"><STRONG>pjsua.gz</STRONG></A> (74 KB)<BR>

-</P>

-

-<H3>Release Notes:</H3>

-<ul>

-<li>Simple <strong>STUN</strong> client support.<BR>

-  SIP UDP port and media RTP/RTCP ports are now STUN aware. <BR>

-</li>

-<li>Client <strong>registration</strong> tested<BR>

-  Including digest authentication, tested with iptel.org.

-</li>

-<li>Major changed in <strong>I/O queue</strong>, now callback is used.<BR>

-  Callback is better because multiple libraries can register to single I/O queue.

-  It was not possible with previous implementation, because the function which does

-  polling needs to understand what to do when a key is signalled. The changes was

-  initially needed to support STUN, but then I decided that the STUN client 

-  implementation uses the simpler select() (in stun_client.c). But the changes in

-  I/O queue stays there because it's better than previous implementation.

-</li>

-<li>Merge <strong>SDP</strong> library into PJMEDIA (no more PJSDP).<BR>

-  PJSDP only has couple of files (sdp.[hc]), not worth maintaining a library.

-</li>

-<li>Fixed bug in select() I/O queue (not thread safe).

-</li>

-</ul>

-

-

-</BODY>

-</HTML>