README.md

   1 aMule
   2 =====
   3
   4 ![aMule](https://raw.githubusercontent.com/amule-project/amule/master/amule.png)
   5
   6 aMule is an eMule-like client for the eDonkey and Kademlia networks.
   7
   8 [Forum] | [Wiki] | [FAQ]
   9
  10 [![Debian CI](https://badges.debian.net/badges/debian/stable/amule/version.svg)](https://buildd.debian.org/amule)
  11 [![Debian CI](https://badges.debian.net/badges/debian/testing/amule/version.svg)](https://buildd.debian.org/amule)
  12
  13 [Forum]: http://forum.amule.org/                "aMule Forum"
  14 [Wiki]:  http://wiki.amule.org/                 "aMule Wiki"
  15 [FAQ]:   http://wiki.amule.org/wiki/FAQ_aMule   "FAQ on aMule"
  16
  17
  18 Overview
  19 --------
  20
  21 aMule is a multi-platform client for the ED2K file sharing network and based on
  22 the windows client eMule. aMule started in August 2003, as a fork of xMule,
  23 which is a fork of lMule.
  24
  25 aMule currently supports Linux, FreeBSD, OpenBSD, Windows, MacOS X and X-Box on
  26 both 32 and 64 bit computers.
  27
  28 aMule is intended to be as user friendly and feature rich as eMule and to
  29 remain faithful to the look and feel of eMule so users familiar with either
  30 aMule or eMule will be able switch between the two easily.
  31
  32 Since aMule is based upon the eMule codebase, new features in eMule tend to
  33 find their way into aMule soon after their inclusion into eMule so users of
  34 aMule can expect to ride the cutting-edge of ED2k clients.
  35
  36
  37 Features
  38 --------
  39
  40 * an all-in-one app called `amule`.
  41 * a daemon app called `amuled`. It's amule but with no interface.
  42 * a client for the server called `amulegui` to connect to a local or distant
  43   amuled.
  44 * `amuleweb` to access amule from a web browser.
  45 * `amulecmd` to access amule from the command line.
  46
  47
  48 Compiling
  49 ---------
  50
  51 In general, compiling aMule should be as easy as running `configure` and `make`.
  52 There are [detailed instructions][1] on the wiki for compiling on a number of
  53 different platforms, though they may be outdated a bit... (updates are welcome).
  54
  55 [1]: http://wiki.amule.org/wiki/Compile         "How to compile and install aMule"
  56
  57
  58 Setting Up
  59 ----------
  60
  61 aMule comes with reasonable default settings and should be usable as-is.
  62 However, to receive a [HighID] you need to open aMule's ports on your
  63 firewall and/or forward them on your router. Again, you'll find detailed
  64 articles on the wiki helping you [get HighID][2] and [setting up firewall
  65 rules][3] for aMule.
  66
  67 [HighID]: http://wiki.amule.org/wiki/FAQ_eD2k-Kademlia#What_is_LowID_and_HighID.3F
  68           "What is LowID and HighID?"
  69
  70 [2]: http://wiki.amule.org/wiki/Get_HighID      "How to get HighID"
  71 [3]: http://wiki.amule.org/wiki/Firewall        "How to set up firewall rules for aMule"
  72
  73
  74 Reporting Bugs
  75 --------------
  76
  77 We aren't perfect and so aMule isn't perfect, too. We know that. If you find a
  78 bug or miss a feature you can report/request it either on the [forum], the
  79 [bug tracker][4] or on [GitHub][5].
  80
  81 [4]: http://bugs.amule.org/                             "aMule Bug Tracker"
  82 [5]: https://github.com/amule-project/amule/issues      "aMule Issues"
  83
  84
  85 Contributing
  86 ------------
  87
  88 *Contributions are always welcome!*
  89
  90 You can contribute to aMule several ways:
  91
  92 * Contributing code. You can fix some bugs, implement new features, or
  93   whatever you want. The preferred way is opening a [pull request][6] on
  94   GitHub, but you can also post your patch on the [forum].
  95 * Translating. You can [translate aMule][7], [translate the wiki][8] or
  96   [translate aMule's documentation][9] to your language.
  97 * Fixing the wiki. aMule's wiki contains a lot of old, outdated information,
  98   that is simply not true anymore. One should read through the pages, update
  99   manuals and references and remove obsolate information.
 100
 101 [6]: https://github.com/amule-project/amule/pulls  "aMule Pull Requests"
 102 [7]: http://wiki.amule.org/wiki/Translations       "Translating aMule"
 103 [8]: http://wiki.amule.org/wiki/Translating_Wiki   "Translating the wiki"
 104 [9]: http://wiki.amule.org/wiki/Translating_Docs   "Translating the documentation"