github
/
aria2
mirror of https://github.com/aria2/aria2
1
0
Fork 0
Code Issues Releases Wiki Activity

Updated README.rst. 

Added section which describes building documentation using Sphinx.
Several documentaiton updates.
pull/20/head
Tatsuhiro Tsujikawa 2012-05-19 22:34:46 +09:00
parent afcd95dec7
commit b05959ec92
1 changed files with 18 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
README.rst
View File

@ -22,6 +22,7 @@ downloading a file like BitTorrent.
The project page is located at http://aria2.sourceforge.net/. The project page is located at http://aria2.sourceforge.net/.
See `aria2 Online Manual <http://aria2.sourceforge.net/manual/en/html/>`_ See `aria2 Online Manual <http://aria2.sourceforge.net/manual/en/html/>`_
(`Russian translation <http://aria2.sourceforge.net/manual/ru/html/>`_)
and `the usage examples <http://sourceforge.net/apps/trac/aria2/wiki/UsageExample>`_ to learn how to use aria2. and `the usage examples <http://sourceforge.net/apps/trac/aria2/wiki/UsageExample>`_ to learn how to use aria2.
Features Features
@ -169,8 +170,8 @@ You can use libexpat1-dev instead of libxml2-dev:
You may also need pkg-config to detect the above mentioned libraries. You may also need pkg-config to detect the above mentioned libraries.
On Fedora you need the following packages: On Fedora you need the following packages: gcc, gcc-c++, kernel-devel,
gcc, gcc-c++, kernel-devel, libgcrypt-devel, libgcrypt-devel, libxml2-devel, openssl-devel libgcrypt-devel, libgcrypt-devel, libxml2-devel, openssl-devel
If you downloaded source code from git repository, you have to run If you downloaded source code from git repository, you have to run
following command to generate configure script and other files following command to generate configure script and other files
@ -178,6 +179,8 @@ necessary to build the program::
$ autoreconf -i $ autoreconf -i
Also you need `Sphinx <http://sphinx.pocoo.org/>`_ to build man page.
If you are building aria2 for Mac OS X, take a look at If you are building aria2 for Mac OS X, take a look at
build_osx_release.sh, which builds OSX universal binary DMG. build_osx_release.sh, which builds OSX universal binary DMG.
@ -217,6 +220,16 @@ aria2 uses CppUnit for automated unit testing. To run the unit test::
$ make check $ make check
Building documentation
----------------------
`Sphinx <http://sphinx.pocoo.org/>`_ is used to build the
documentation. aria2 man pages will be build when you run ``make`` if
they are not up-to-date. You can also build HTML version of aria2 man
page by ``make html``. The HTML version manual is also available at
`online <http://aria2.sourceforge.net/manual/en/html/>`_ (`Russian
translation <http://aria2.sourceforge.net/manual/ru/html/>`_).
BitTorrrent BitTorrrent
----------- -----------
@ -335,6 +348,6 @@ References
* http://aria2.sourceforge.net/ * http://aria2.sourceforge.net/
* http://sourceforge.net/apps/trac/aria2/wiki * http://sourceforge.net/apps/trac/aria2/wiki
* https://github.com/tatsuhiro-t/aria2 * https://github.com/tatsuhiro-t/aria2
* http://tools.ietf.org/html/rfc5854 * `RFC 5854 The Metalink Download Description Format <http://tools.ietf.org/html/rfc5854>`_
* http://tools.ietf.org/html/rfc6249 * `RFC 6249 Metalink/HTTP: Mirrors and Hashes <http://tools.ietf.org/html/rfc6249>`_
* http://tools.ietf.org/html/rfc6455 * `RFC 6455 The WebSocket Protocol <http://tools.ietf.org/html/rfc6455>`_