


                                 -----------
                                    xMule
                                 -----------
                 The Multiplatform Fork of the eMule Client
              


 About
-------

This program is a multiplatform fort of eMule client using wxWindows class library.


 Installation
--------------

See INSTALL file


 Basic xMule Tips
------------------

* ALWAYS run xMule as a REGULAR USER
* NEVER run xMule as root (unless you have a repressive ISP and need to use
  ports lower than 1024).
* If you are behind a firewall or router, be sure that ports 4662 (TCP)
  and 4672 (UDP) are unblocked, or you will *always* receive a low ID.
* Obtain an appropriate server.met:  e.g., if you are a dialup, using
  the max server list is not recommend.
* Set your temp and shared directories in Preferences->Directories
   *  To recursively select a certain directory, click on its box while holding
      down the CTRL button.
*  You should *NOT* share
   *  Your temp download directory!
   *  You /etc directory
   *  Probably not your /var, /lib, /boot, or /usr directory
   *  Certainly make sure that any really confidential files (password files, 
      private SSH keys, credit card numbers :) are *not* shared.  So generally
      do not share ~, although ~/files or the equivalent should be OK.
*  Remember that you get certain download priveledges with those xMule and 
   eMule users to whom you upload files, in the form of reduced queue waits.
* Please note that compilation with optimizations is not supported. If you do
  use optimization flags, don't come back crying that it is unstable. With
  optimization, unpredictable and strange bugs will probably accour.

 Obtaining your first server list
----------------------------------

1) Use one of the following links in the "Update server.met from URL" box in 
   the Server tab.  They are apparently updated every 20 minutes.

   *  The current top 50 servers (these fill up fast)
	http://ocbmaurice.dyndns.org/pl/slist.pl/server.met?download
   *  The current top 150 servers
	http://ocbmaurice.dyndns.org/pl/slist.pl/server.met?download/server-good.met 
   *  The biggest list (~300 servers) maintained by the site.  Only if you have
      a very decent connection, AFAIK.
	http://ocbmaurice.dyndns.org/pl/slist.pl/server.met?download/server-max.met 

 Icons
-------
To find descriptions of the various icons found inside xMule, take a
look at http://www.emule-project.net/faq/icons.htm

 License
---------

xMule -- like eMule -- is released under the GNU General Public License 
See COPYING file for details.


 Developers
------------
  Timo Kujala <tkujala@lut.fi>
  BedBoi  <bedboi@users.sourceforge.net>
  Pure_Ascii <pure_ascii@users.sourceforge.net>
  Marcelo Falero <mfalero@users.sourceforge.net>
  Fuentes Xavier <furax@r00tworld.com>
  Ted R. Smith <un-thesis@wakeup-people.com>
  Alo Sarv (aka Madcat) <madcat@xmule.org>

 Want to help?
---------------
xMule is a free software project and requires the cooperation of it's users to help improve 
the quality of the software.  We welcome all contributions to the project in the form of new 
features, bug fixes and feature requests.

If you are not a programmer you can still contribute by providing good bug reports when you 
come accross a problem with the xMule software.  A good bug report gives the project team 
enough information to reproduce the bug (so we can see it in action) and fix it.  If possible, 
try to isolate the conditions under which the bug occurs (eg. does it happen on some specific 
window, with some specific files, some specific conditions etc.) and provide as much detail as 
you can in your report.

If you are a programmer and can fix the bug you observe, please send us a patch or a note 
about how you fixed the problem.

 Links
-------

http://www.xmule.org
        - xMule homepage
http://www.wxwindows.org
        - wxWindows toolkit homepage
http://www.emule-project.net
	- eMule homepage
irc.unthesis.ws: #xmule - IRC Channel

 Legal Notice
--------------
  xMule is an interface to the eDonkey medium. As such, the xMule developers have absolutely 
no control or say over what is transferred on this medium and cannot be held liable for any 
non-personal copyright infringements or other illegal activities.

 -- Last modified by Madcat at 03:50 GMT on 2003-06-06 --
