update readme

git-svn-id: http://svn.code.sf.net/p/retroshare/code/trunk@769 b45a01b8-16f6-495d-af2f-9b41ad6348cc
This commit is contained in:
defnax 2008-10-28 12:19:02 +00:00
parent 2a98419498
commit a50cd7ceb1
2 changed files with 290 additions and 188 deletions

View file

@ -1,150 +1,243 @@
Compiling + Running RetroShare (V0.3.0) Compiling + Running RetroShare (V0.4.xxx)
------------------------------------------------------------- ------------------------------------------------------------------------------------------
Quick Requirements: Quick Requirements:
--------------------------------------------- ------------------------------------------------------------------------------------------
Libraries/Tools: Libraries/Tools:
C/C++ Compiler. (standard on Linux/cygwin) C/C++ Compiler. (standard on Linux/cygwin)
OpenSSL-0.9.7g-xpgp OpenSSL-0.9.7g-xpgp
KadC Dht library Qt-4.3 development libraries.
Qt-4.2 development libraries.
RetroShare Source Code: ( from sf.net/projects/retroshare)
RetroShare Source Code: ( from sf.net/projects/retroshare) Qt-GUI-XXX.tgz
Qt-GUI-XXX.tgz retroshare-src-v0.4.XXX.tgz
retroshare-src-v0.3.XXX.tgz
Windows Requirements:
Windows Requirements: Cygwin (Windows Only)
Cygwin (Windows Only) Pthreads (Windows Only)
Pthreads (Windows Only) Zlib (Windows Only)
Zlib (Windows Only)
--------------------------------------------- ------------------------------------------------------------------------------------------
Build Scripts are avaible on SVN for Debian and Ubuntu:
OpenSSL-0.9.7g-xpgp is available at: http://retroshare.svn.sourceforge.net/viewvc/retroshare/trunk/build_scripts/
http://www.lunamutt.com/retroshare/openssl-0.9.7g-xpgp-0.1c.tgz
KadC (latest) is available from sourceforge.net OpenSSL-0.9.7g-xpgp is available at:
http://www.lunamutt.com/retroshare/openssl-0.9.7g-xpgp-0.1c.tgz
Download/Compile as per instructions...
--------------------------------------------- Download/Compile as per instructions...
Compiling Linux ------------------------------------------------------------------------------------------
---------------------------------------------
Compiling Linux
(1) compile openSSL-0.9.7g-xpgp. ------------------------------------------------------------------------------------------
(2) compile KadC. (and correct the library) (1) compile openSSL-0.9.7g-xpgp.
(4) Modify ./make.opts (2) compile miniupnpc
(4a) modify the Makefile so that: OS=Linux or OS=Win
(4c) Define SSL_DIR to point to openSSL-0.9.7g-xpgp. (4) Modify ./make.opts
(4c) Define KADC_DIR to point to KadC (4a) modify the Makefile so that: OS=Linux or OS=Win
(4c) Define SSL_DIR to point to openSSL-0.9.7g-xpgp.
(5) type: make (4c) Define UPNPC_DIR to point to miniupnpc
This builds ./lib/libretroshare.a,
and the various test programs. (5) type: make
This builds ./lib/libretroshare.a,
There is server-only (no GUI) executable and the various test programs.
compiled in ./rsiface/retroshare-nogui,
you can run this to check that its working. There is server-only (no GUI) executable
compiled in ./rsiface/retroshare-nogui,
--------------------------------------------- you can run this to check that its working.
Compiling Linux (Alternative Instructions from Bharath) ------------------------------------------------------------------------------------------
---------------------------------------------
here's how to compiled retroshare on ubuntu linux: Compiling Linux (Alternative Instructions from Bharath)
------------------------------------------------------------------------------------------
compile openssl: here's how to compiled retroshare on ubuntu linux:
1. Get the patched version of openssl (openssl-0.9.7g-xpgp, from http://www.lunamutt.com)
2. run: compile openssl:
./config 1. Get the patched version of openssl (openssl-0.9.7g-xpgp, from http://www.lunamutt.com)
make 2. run:
make test ./config
make
compile KadC: make test
1. Get KadC library from http://kadc.sourceforge.net/
2. run: compile miniupnpc:
make 1. Get miniupnpc library from http://miniupnp.free.fr/files/download.php?file=miniupnpc-1.0.tar.gz
2. run:
install packages needed for retroshare compile: make
sudo apt-get install libxft-dev
sudo apt-get install libXinerama-dev install packages needed for retroshare compile:
sudo apt-get install libxft-dev
complile retroshare: sudo apt-get install libXinerama-dev
1. set directories in make.opt:
RS_DIR=/home/dev/rs-v0.3.0-pr8/src complile retroshare:
SSL_DIR=/home/dev/openssl-0.9.7g-xpgp-0.1c 1. set directories in make.opt:
KADC_DIR=/home/dev/KadC RS_DIR=/home/dev/rs-v0.3.0-pr8/src
2. comment out the directory declarations uncer Cygwin since that will override your directory declarations from 1. SSL_DIR=/home/dev/openssl-0.9.7g-xpgp-0.1c
3. change RSLIBS = -L$(LIBDIR) -lretroshare -L$(SSL_DIR) -lssl -lcrypto -lpthread -lKadC UPNPC_DIR=/home/dev/miniupnpc
to
RSLIBS = -L$(LIBDIR) -lretroshare -L$(SSL_DIR) -lssl -lcrypto -lpthread -L$(KADC_DIR) -lKadC 2. comment out the directory declarations uncer Cygwin since that will override your directory declarations from 1.
4. run: 3. change RSLIBS = -L$(LIBDIR) -lretroshare -L$(SSL_DIR) -lssl -lcrypto -lpthread -lminiupnpc
make to
RSLIBS = -L$(LIBDIR) -lretroshare -L$(SSL_DIR) -lssl -lcrypto -lpthread -L$(UPNPC_DIR) -lminiupnpc
Hope this helps. 4. run:
make
---------------------------------------------
Compiling the Qt GUI Hope this helps.
_____________________________________________
(1) untar the Qt-GUI source package. run qmake, ------------------------------------------------------------------------------------------
tar -xvzf Qt-GUI-XXXX.tgz Compiling the skinobject (only Required when its enabled then compile with QT 4.3.x)
------------------------------------------------------------------------------------------
cd Qt-Gui-XXX/src/
qmake-qt4 Retroshare.pro 1. Download skinobject from https://sourceforge.net/projects/qskinwindows/
(2) tweak the makefile: The default makefile http://downloads.sourceforge.net/qskinwindows/qskinobject-0.6.1.tar.bz2?
doesn't have the links to the retroshare
libraries. It should something like this: 2. untar the qskinobject-0.6.1.tar.bz2
RSLIBS = -L/home/dev/prog/devel/rs-v0.3.0XXX/src/lib -lretroshare -lKadC 3. run:
SSLLIBS = -L/home/dev/prog/devel/openssl-0.9.7g-xpgp -lssl -lcrypto qmake
LIBS = $(SUBLIBS) $(RSLIBS) $(SSLLIBS) -L/usr/lib -lQtXml -lQtGui -lQtNetwork -lQtCore -lpthread make
This should build you an executable: 4.Copy the libskin.a to your retroshare libs directory.
RetroShare. 5.then add to LIBS= -lskin -lgdi32 to the RetroShare.pro file:
------------------------------------------------ example(linux):
This has been compiled on the following platforms:
(a) Debian Linux (stable/testing/unstable) TARGET = RetroShare
(b) Suse Linux (9.X/10.X) RSLIBS = -L/path/to/your/retroshare/libs/directory/ -lretroshare -lminiupnpc -lskin -lssl -lcrypto
(c) WinXP LIBS = $(RSLIBS)
------------------------------------------------ example (Windows):
WIN XP Compilation.
------------------------------------------------ win32
{
This much harder, and more perilous than the RC_FILE = gui/images/retroshare_win.rc
Linux compilation: It requires both the cygwin
and the mingw compilers... "LIBS += -L"../../winlibs" -lretroshare -lssl -lcrypto -lpthreadGC2d -lminiupnpc -lz -lws2_32 -luuid -lole32 -liphlpapi -lcrypt32-cygwin -lskin -lgdi32
CONFIG += qt release"
Need: }
Cygwin development environment
Qt4.2 opensource development kit + MinGw. ------------------------------------------------------------------------------------------
source code for all libraries.
Compiling QCheckers game
In Brief: ------------------------------------------------------------------------------------------
UNDER Cygwin:
(1) Compile openssl-xpgp. 1.qmake
(2) Compile pthreads. 2.make
(3) Compile zlib. 3.Copy the libqcheckers.a to your retroshare libs directory.
(4) Compile KadC. (there are some tweaks, 5.then add to LIBS= -lqcheckers to the RetroShare.pro file:
needed to the code)
Example(linux):
(5) Compile retroshare-v0.3.0
RSLIBS = -L/path/to/your/retroshare/libs/directory/ -lretroshare -lminiupnpc -lskin -lqcheckers -lssl -lcrypto
UNDER Mingw: LIBS = $(RSLIBS)
(6) Compile the Qt-Gui.
Example (Windows):
Email me if you're having trouble: win32
retroshare@lunamutt.com {
--------------------------------------------- RC_FILE = gui/images/retroshare_win.rc
"LIBS += -L"../../winlibs" -lretroshare -lssl -lcrypto -lpthreadGC2d -lminiupnpc -lz -lws2_32 -luuid -lole32 -liphlpapi -lcrypt32-cygwin -lskin -lqcheckers -lgdi32
CONFIG += qt release"
}
------------------------------------------------------------------------------------------
Compiling SMPlayer
------------------------------------------------------------------------------------------
1.qmake
2.make
3.Copy the libsmplayer.a to your retroshare libs directory.
5.then add to LIBS -lsmplayer to the RetroShare.pro file.
------------------------------------------------------------------------------------------
Compiling the Qt GUI
------------------------------------------------------------------------------------------
(1) untar the Qt-GUI source package. run qmake,
tar -xvzf Qt-GUI-XXXX.tgz
cd Qt-Gui-XXX/src/
qmake-qt4 Retroshare.pro
(2) tweak the makefile: The default makefile
doesn't have the links to the retroshare
libraries. It should something like this:
RSLIBS = -L/home/dev/prog/devel/rs-v0.3.0XXX/src/lib -lretroshare -lminiupnpc
SSLLIBS = -L/home/dev/prog/devel/openssl-0.9.7g-xpgp -lssl -lcrypto
LIBS = $(SUBLIBS) $(RSLIBS) $(SSLLIBS) -L/usr/lib -lQtXml -lQtGui -lQtNetwork -lQtCore -lpthread
This should build you an executable:
RetroShare.
------------------------------------------------
This has been compiled on the following platforms:
(a) Debian Linux (stable/testing/unstable)
(b) Suse Linux (9.X/10.X)
(c) WinXP
------------------------------------------------
WIN XP Compilation.
------------------------------------------------
This much harder, and more perilous than the
Linux compilation: It requires both the cygwin
and the mingw compilers...
Need:
Cygwin development environment:
http://www.cygwin.com/cygwin/setup.exe
Qt4.3.x opensource development kit + MinGw:
http://wftp.tu-chemnitz.de/pub/Qt/qt/source/qt-win-opensource-4.3.5-mingw.exe
source code for all libraries.:
http://downloads.sourceforge.net/retroshare/retroshare-pkg-linux-src-v0.4.09b.tgz?
retroshare-pkg-linux-src-v0.4.09b.tgz are Libraries included:
openssl-0.9.7g-xpgp-0.1c.tgz
miniupnpc-1.0.tar.gz
smplayer-svn-280308.tgz
Libraries for Windows needs:
pthreads: http://sourceware.org/pthreads-win32/
zlib: http://www.zlib.net/
In Brief:
UNDER Cygwin:
(1) Compile openssl-xpgp.
(2) Compile miniunpnc
(3) Compile pthreads.
(4) Compile zlib.
(5) Compile retroshare-v0.4.x
UNDER Mingw:
(6) Compile SMPlayer ( qmake + make )
(7) Compile the Qt-Gui. ( qmake + make )
Email me if you're having trouble:
retroshare@lunamutt.com
---------------------------------------------

View file

@ -1,46 +1,47 @@
Compiling + Running RetroShare (V0.3.0) Compiling + Running RetroShare (V0.4.xxx)
------------------------------------------------------------- ------------------------------------------------------------------------------------------
Quick Requirements: Quick Requirements:
--------------------------------------------- ------------------------------------------------------------------------------------------
Libraries/Tools: Libraries/Tools:
C/C++ Compiler. (standard on Linux/cygwin) C/C++ Compiler. (standard on Linux/cygwin)
OpenSSL-0.9.7g-xpgp OpenSSL-0.9.7g-xpgp
KadC Dht library Qt-4.3 development libraries.
Qt-4.2 development libraries.
qskinobject library (Required when compile with QT 4.3.x)
RetroShare Source Code: ( from sf.net/projects/retroshare) RetroShare Source Code: ( from sf.net/projects/retroshare)
Qt-GUI-XXX.tgz Qt-GUI-XXX.tgz
retroshare-src-v0.3.XXX.tgz retroshare-src-v0.4.XXX.tgz
Windows Requirements: Windows Requirements:
Cygwin (Windows Only) Cygwin (Windows Only)
Pthreads (Windows Only) Pthreads (Windows Only)
Zlib (Windows Only) Zlib (Windows Only)
---------------------------------------------
------------------------------------------------------------------------------------------
Build Scripts are avaible on SVN for Debian and Ubuntu:
http://retroshare.svn.sourceforge.net/viewvc/retroshare/trunk/build_scripts/
OpenSSL-0.9.7g-xpgp is available at: OpenSSL-0.9.7g-xpgp is available at:
http://www.lunamutt.com/retroshare/openssl-0.9.7g-xpgp-0.1c.tgz http://www.lunamutt.com/retroshare/openssl-0.9.7g-xpgp-0.1c.tgz
KadC (latest) is available from sourceforge.net
Download/Compile as per instructions... Download/Compile as per instructions...
--------------------------------------------- ------------------------------------------------------------------------------------------
Compiling Linux Compiling Linux
--------------------------------------------- ------------------------------------------------------------------------------------------
(1) compile openSSL-0.9.7g-xpgp. (1) compile openSSL-0.9.7g-xpgp.
(2) compile KadC. (and correct the library) (2) compile miniupnpc
(4) Modify ./make.opts (4) Modify ./make.opts
(4a) modify the Makefile so that: OS=Linux or OS=Win (4a) modify the Makefile so that: OS=Linux or OS=Win
(4c) Define SSL_DIR to point to openSSL-0.9.7g-xpgp. (4c) Define SSL_DIR to point to openSSL-0.9.7g-xpgp.
(4c) Define KADC_DIR to point to KadC (4c) Define UPNPC_DIR to point to miniupnpc
(5) type: make (5) type: make
This builds ./lib/libretroshare.a, This builds ./lib/libretroshare.a,
@ -50,10 +51,10 @@ Compiling Linux
compiled in ./rsiface/retroshare-nogui, compiled in ./rsiface/retroshare-nogui,
you can run this to check that its working. you can run this to check that its working.
--------------------------------------------- ------------------------------------------------------------------------------------------
Compiling Linux (Alternative Instructions from Bharath) Compiling Linux (Alternative Instructions from Bharath)
--------------------------------------------- ------------------------------------------------------------------------------------------
here's how to compiled retroshare on ubuntu linux: here's how to compiled retroshare on ubuntu linux:
compile openssl: compile openssl:
@ -63,8 +64,8 @@ here's how to compiled retroshare on ubuntu linux:
make make
make test make test
compile KadC: compile miniupnpc:
1. Get KadC library from http://kadc.sourceforge.net/ 1. Get miniupnpc library from http://miniupnp.free.fr/files/download.php?file=miniupnpc-1.0.tar.gz
2. run: 2. run:
make make
@ -76,18 +77,23 @@ here's how to compiled retroshare on ubuntu linux:
1. set directories in make.opt: 1. set directories in make.opt:
RS_DIR=/home/dev/rs-v0.3.0-pr8/src RS_DIR=/home/dev/rs-v0.3.0-pr8/src
SSL_DIR=/home/dev/openssl-0.9.7g-xpgp-0.1c SSL_DIR=/home/dev/openssl-0.9.7g-xpgp-0.1c
KADC_DIR=/home/dev/KadC UPNPC_DIR=/home/dev/miniupnpc
2. comment out the directory declarations uncer Cygwin since that will override your directory declarations from 1. 2. comment out the directory declarations uncer Cygwin since that will override your directory declarations from 1.
3. change RSLIBS = -L$(LIBDIR) -lretroshare -L$(SSL_DIR) -lssl -lcrypto -lpthread -lKadC 3. change RSLIBS = -L$(LIBDIR) -lretroshare -L$(SSL_DIR) -lssl -lcrypto -lpthread -lminiupnpc
to to
RSLIBS = -L$(LIBDIR) -lretroshare -L$(SSL_DIR) -lssl -lcrypto -lpthread -L$(KADC_DIR) -lKadC RSLIBS = -L$(LIBDIR) -lretroshare -L$(SSL_DIR) -lssl -lcrypto -lpthread -L$(UPNPC_DIR) -lminiupnpc
4. run: 4. run:
make make
Hope this helps. Hope this helps.
---------------------------------------------
Compiling the skinobject (only Required when compile with QT 4.3.x) ------------------------------------------------------------------------------------------
Compiling the skinobject (only Required when its enabled then compile with QT 4.3.x)
------------------------------------------------------------------------------------------
1. Download skinobject from https://sourceforge.net/projects/qskinwindows/ 1. Download skinobject from https://sourceforge.net/projects/qskinwindows/
@ -106,7 +112,7 @@ make
example(linux): example(linux):
TARGET = RetroShare TARGET = RetroShare
RSLIBS = -L/path/to/your/retroshare/libs/directory/ -lretroshare -lKadC -lKadC -lminiupnpc -lskin -lssl -lcrypto RSLIBS = -L/path/to/your/retroshare/libs/directory/ -lretroshare -lminiupnpc -lskin -lssl -lcrypto
LIBS = $(RSLIBS) LIBS = $(RSLIBS)
example (Windows): example (Windows):
@ -115,48 +121,51 @@ win32
{ {
RC_FILE = gui/images/retroshare_win.rc RC_FILE = gui/images/retroshare_win.rc
"LIBS += -L"../../winlibs" -lretroshare -lssl -lcrypto -lpthreadGC2d -lKadC -lminiupnpc -lz -lws2_32 -luuid -lole32 -liphlpapi -lcrypt32-cygwin -lskin -lgdi32 "LIBS += -L"../../winlibs" -lretroshare -lssl -lcrypto -lpthreadGC2d -lminiupnpc -lz -lws2_32 -luuid -lole32 -liphlpapi -lcrypt32-cygwin -lskin -lgdi32
CONFIG += qt release" CONFIG += qt release"
} }
--------------------------------------------- ------------------------------------------------------------------------------------------
Compiling QCheckers game Compiling QCheckers game
_____________________________________________ ------------------------------------------------------------------------------------------
1.qmake 1.qmake
2.make 2.make
3.Copy the libqcheckers.a to your retroshare libs directory. 3.Copy the libqcheckers.a to your retroshare libs directory.
5.then add to LIBS= -lqcheckers to the RetroShare.pro file: 5.then add to LIBS= -lqcheckers to the RetroShare.pro file:
example(linux): Example(linux):
RSLIBS = -L/path/to/your/retroshare/libs/directory/ -lretroshare -lKadC -lKadC -lminiupnpc -lskin -lqcheckers -lssl -lcrypto RSLIBS = -L/path/to/your/retroshare/libs/directory/ -lretroshare -lminiupnpc -lskin -lqcheckers -lssl -lcrypto
LIBS = $(RSLIBS) LIBS = $(RSLIBS)
example (Windows): Example (Windows):
win32 win32
{ {
RC_FILE = gui/images/retroshare_win.rc RC_FILE = gui/images/retroshare_win.rc
"LIBS += -L"../../winlibs" -lretroshare -lssl -lcrypto -lpthreadGC2d -lKadC -lminiupnpc -lz -lws2_32 -luuid -lole32 -liphlpapi -lcrypt32-cygwin -lskin -lqcheckers -lgdi32 "LIBS += -L"../../winlibs" -lretroshare -lssl -lcrypto -lpthreadGC2d -lminiupnpc -lz -lws2_32 -luuid -lole32 -liphlpapi -lcrypt32-cygwin -lskin -lqcheckers -lgdi32
CONFIG += qt release" CONFIG += qt release"
} }
---------------------------------------------
------------------------------------------------------------------------------------------
Compiling SMPlayer Compiling SMPlayer
_____________________________________________ ------------------------------------------------------------------------------------------
1.qmake 1.qmake
2.make 2.make
3.Copy the libsmplayer.a to your retroshare libs directory. 3.Copy the libsmplayer.a to your retroshare libs directory.
5.then add to LIBS -lsmplayer to the RetroShare.pro file: 5.then add to LIBS -lsmplayer to the RetroShare.pro file.
_____________________________________________
------------------------------------------------------------------------------------------
---------------------------------------------
Compiling the Qt GUI Compiling the Qt GUI
_____________________________________________ ------------------------------------------------------------------------------------------
(1) untar the Qt-GUI source package. run qmake, (1) untar the Qt-GUI source package. run qmake,
tar -xvzf Qt-GUI-XXXX.tgz tar -xvzf Qt-GUI-XXXX.tgz
@ -169,7 +178,7 @@ _____________________________________________
doesn't have the links to the retroshare doesn't have the links to the retroshare
libraries. It should something like this: libraries. It should something like this:
RSLIBS = -L/home/dev/prog/devel/rs-v0.3.0XXX/src/lib -lretroshare -lKadC RSLIBS = -L/home/dev/prog/devel/rs-v0.3.0XXX/src/lib -lretroshare -lminiupnpc
SSLLIBS = -L/home/dev/prog/devel/openssl-0.9.7g-xpgp -lssl -lcrypto SSLLIBS = -L/home/dev/prog/devel/openssl-0.9.7g-xpgp -lssl -lcrypto
LIBS = $(SUBLIBS) $(RSLIBS) $(SSLLIBS) -L/usr/lib -lQtXml -lQtGui -lQtNetwork -lQtCore -lpthread LIBS = $(SUBLIBS) $(RSLIBS) $(SSLLIBS) -L/usr/lib -lQtXml -lQtGui -lQtNetwork -lQtCore -lpthread