Changeset 1672

Show
Ignore:
Timestamp:
08/05/05 13:22:45 (3 years ago)
Author:
madcat
Message:

Updated README.

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • hydranode-oldbld/README

    r1296 r1672  
    22                Hydranode - Modular MultiPlatform P2P Client Framework 
    33 
    4 * Compilation 
    5         If you checked out the source from SVN, you need to run `./autogen.sh' 
    6 to re-generate the configure script. 
    7         After that, simply run `./configure' and `make' to build the 
    8 application. The binaries are created in their respective subdirectories, and 
    9 symlinked to top-level directory for easier access. 
    10         Note that one un-common pre-requirement for compiling hydranode is Boost 
    11 libraries, available from http://www.boost.org. Simply unpack the boost tarball, 
    12 and run configure with `--with-boost-path=<path>' where <path> is absolute or 
    13 relative path to your boost directory. Note that you do not need to compile 
    14 Boost libraries separately - they are compiled by hydranode build system. The 
    15 default search directory for boost files is $(HOME)/boost_1_32_0, which is 
    16 created if you unpack the tarball to your home directory. 
     4Compilation 
     5------------- 
    176 
    18         The following binaries are created (and symlinked to top-level 
    19 directory): 
    20         - src/hydranode             Main executable 
    21         - modules/ed2k/ed2k.so      ED2K network module 
    22         - modules/hnsh/hnsh.so      HydraNode Shell Server module 
     7  Hydranode consists of many components, plugins and libraries, many of 
     8  which have external dependancies. In order to compile Hydranode, you need the 
     9  following tools/libraries installed on system: 
    2310 
    24 * Installation 
    25         To install Hydranode system-wide, simply run "make install". By default, 
    26 Hydranode is installed to /opt/hydranode hierarchy, altough you may override 
    27 the default prefix by passing --prefix to configure. Note that this step is 
    28 completely optional - you can use the application from the build directory as 
    29 well, without installing it systemwide (e.g. if you do not have root access). 
     11 * bjam executable for your platform 
     12        Windows:   http://prdownloads.sourceforge.net/boost/boost-jam-3.1.10-1-ntx86.zip?download 
     13        Linux:     http://prdownloads.sourceforge.net/boost/boost-jam-3.1.10-1-linuxx86.tgz?download 
     14        Mac OS X:  http://prdownloads.sourceforge.net/boost/boost-jam-3.1.10-1-macosxppc.tgz?download 
     15        Linux/RPM: http://prdownloads.sourceforge.net/boost/boost-jam-3.1.10-1.i386.rpm?download 
    3016 
    31 * Usage 
    32         Launch the application by running the main executable, `hydranode`. On 
    33 POSIX systems, you may also background the process by passing --background (or 
    34 -b) option to it. For more options, see ./hydranode --help. Configuration files 
    35 are stored in your home directory, in .hydranode/ subdirectory. Temp/Incoming 
    36 folders are created at .hydranode/Temp and .hydranode/Incoming, respectivly. 
    37         A shell interface is listening on localhost port 9999 for controlling 
    38 the client. By default, the shell listens on localhost only, altough you may 
    39 change it from configuration file. It is not recommended to have the shell 
    40 listening on ports open to the outside world, since anyone having access to the 
    41 shell can have full control of the client. 
    42         Note: If the shell interface is not accessible for some reason, study 
    43 the output from the main executable startup - it should always display what went 
    44 wrong in the startup process, giving you hints on what to do. 
     17 * C++ compiler 
     18        Windows:   http://prdownloads.sourceforge.net/mingw/MinGW-4.1.0.exe?download 
     19        Linux/Mac: Consult your distribution vendor; most likely you already have it installed. 
     20 
     21 * Boost C++ libraries 
     22        Windows:   http://prdownloads.sourceforge.net/boost/boost_1_32_0.zip?download 
     23        Linux/Mac: http://prdownloads.sourceforge.net/boost/boost_1_32_0.tar.bz2?download 
     24 
     25        Unpack them to C:\ (on windows) or to your HOME directory (unix). 
     26 
     27        NOTE: You do not need to compile them, Hydranode only uses headers from 
     28              the Boost libraries source. 
     29 
     30 * Trolltech QT4 GUI library (only required for user interfaces) 
     31        Windows:   http://www.trolltech.com/download.html?target=http://sunsite.rediris.es/mirror/Qt/source/qt-win-opensource-desktop-4.0.0-mingw.exe 
     32        Unix/X11:  http://www.trolltech.com/download.html?target=http://sunsite.rediris.es/mirror/Qt/source/qt-x11-opensource-desktop-4.0.0.tar.bz2 
     33        Mac OS X:  http://www.trolltech.com/download.html?target=http://sunsite.rediris.es/mirror/Qt/source/qt-mac-opensource-desktop-4.0.0.tar.bz2 
     34 
     35  Once you have all that, run "bjam release" in the Hydranode source tree. 
     36  Hydranode Engine, it's support libraries and plugins will be compiled. The 
     37  main executable is "hydranode". "hlink" executable allows sending links to 
     38  a running Hydranode. 
     39 
     40  To compile Hydranode Console (graphical user interface, requires Qt4), run 
     41  "bjam release launcher". "console" executable is created. 
     42 
     43 
     44Usage 
     45----- 
     46 
     47  Launch the application by running the main executable, `hydranode`. On POSIX 
     48  systems, you may also background the process by passing --background (or -b) 
     49  option to it. For more options, see ./hydranode --help. Configuration files 
     50  are stored in your home directory, in .hydranode/ subdirectory. Temp/Incoming 
     51  folders are created at .hydranode/Temp and .hydranode/Incoming, respectivly. 
     52 
     53  A shell interface is listening on localhost port 9999 for controlling 
     54  the client. By default, the shell listens on localhost only, altough you may 
     55  change it from configuration file. It is not recommended to have the shell 
     56  listening on ports open to the outside world, since anyone having access to 
     57  the shell can have full control of the client. 
     58 
     59  Note: If the shell interface is not accessible for some reason, study the 
     60  output from the main executable startup - it should always display what 
     61  went wrong in the startup process, giving you hints on what to do. 
     62 
     63  If you also compiled Hydranode Console, you can run it via "console" 
     64  executable. The Console starts Hydranode Engine process automatically. 
     65 
     66More help or support 
     67-------------------- 
     68 
     69  Should you run into trouble using Hydranode, have feature requests or found 
     70  a bug, feel free to contact us either via the Support Forums at 
     71  http://forum.hydranode.com, or posting a Support Ticket at 
     72  http://dev.hydranode.com/newticket. 
     73 
     74  Should you need to contact the developers directly, send an e-mail to 
     75  madcat@hydranode.com. 
     76 
     77 
     78----------------------------------------- 
     79 
     80 Happy downloading, 
     81 
     82 Alo Sarv <madcat@hydranode.com>, 
     83 on behalf of Hydranode Development Team. 
     84 
     85-----------------------------------------