Git-Mirrors/RetroShare
1
0
Fork 0
mirror of https://github.com/RetroShare/RetroShare.git synced 2025-06-07 14:12:43 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

update readme

Browse source 
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
Download patch file Download diff file Expand all files Collapse all files

157
libretroshare/src/Readme.txt
View file

@ -1,45 +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.
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,
@ -49,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:
@ -62,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
@ -75,20 +77,95 @@ 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 Qt GUI
_____________________________________________
------------------------------------------------------------------------------------------
Compiling the skinobject (only Required when its enabled then compile with QT 4.3.x)
------------------------------------------------------------------------------------------
1. Download skinobject from https://sourceforge.net/projects/qskinwindows/
http://downloads.sourceforge.net/qskinwindows/qskinobject-0.6.1.tar.bz2?
2. untar the qskinobject-0.6.1.tar.bz2
3. run:
qmake
make
4.Copy the libskin.a to your retroshare libs directory.
5.then add to LIBS= -lskin -lgdi32 to the RetroShare.pro file:
example(linux):
TARGET = RetroShare
RSLIBS = -L/path/to/your/retroshare/libs/directory/ -lretroshare -lminiupnpc -lskin -lssl -lcrypto
LIBS = $(RSLIBS)
example (Windows):
win32
{
RC_FILE = gui/images/retroshare_win.rc
"LIBS += -L"../../winlibs" -lretroshare -lssl -lcrypto -lpthreadGC2d -lminiupnpc -lz -lws2_32 -luuid -lole32 -liphlpapi -lcrypt32-cygwin -lskin -lgdi32
CONFIG += qt release"
}
------------------------------------------------------------------------------------------
Compiling QCheckers game
------------------------------------------------------------------------------------------
1.qmake
2.make
3.Copy the libqcheckers.a to your retroshare libs directory.
5.then add to LIBS= -lqcheckers to the RetroShare.pro file:
Example(linux):
RSLIBS = -L/path/to/your/retroshare/libs/directory/ -lretroshare -lminiupnpc -lskin -lqcheckers -lssl -lcrypto
LIBS = $(RSLIBS)
Example (Windows):
win32
{
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, (1) untar the Qt-GUI source package. run qmake,
tar -xvzf Qt-GUI-XXXX.tgz tar -xvzf Qt-GUI-XXXX.tgz
@ -101,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
@ -124,22 +201,38 @@ Linux compilation: It requires both the cygwin
and the mingw compilers... and the mingw compilers...
Need: Need:
Cygwin development environment Cygwin development environment:
Qt4.2 opensource development kit + MinGw. http://www.cygwin.com/cygwin/setup.exe
source code for all libraries.
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: In Brief:
UNDER Cygwin: UNDER Cygwin:
(1) Compile openssl-xpgp. (1) Compile openssl-xpgp.
(2) Compile pthreads. (2) Compile miniunpnc
(3) Compile zlib. (3) Compile pthreads.
(4) Compile KadC. (there are some tweaks, (4) Compile zlib.
needed to the code)
(5) Compile retroshare-v0.3.0 (5) Compile retroshare-v0.4.x
UNDER Mingw: UNDER Mingw:
(6) Compile the Qt-Gui. (6) Compile SMPlayer ( qmake + make )
(7) Compile the Qt-Gui. ( qmake + make )
Email me if you're having trouble: Email me if you're having trouble:

85
retroshare-gui/src/README.txt
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