summaryrefslogtreecommitdiffstats
path: root/README
diff options
context:
space:
mode:
authorme_desk <me_desk@fb96df88-216d-11de-830c-f3023f12d8ac>2012-08-22 16:38:19 +0000
committerme_desk <me_desk@fb96df88-216d-11de-830c-f3023f12d8ac>2012-08-22 16:38:19 +0000
commita85553073f2b0b3451f72ecd614740d638562821 (patch)
tree3a54e3316e4d9ae22fa0a1519166864f34421903 /README
parent5816faa7bdef0d315724566bb0c74cf4cd28eb7a (diff)
downloadpica-pica-a85553073f2b0b3451f72ecd614740d638562821.tar.gz
pica-pica-a85553073f2b0b3451f72ecd614740d638562821.zip
filled README
git-svn-id: svn://localhost/project_picapica/trunk@182 fb96df88-216d-11de-830c-f3023f12d8ac
Diffstat (limited to 'README')
-rw-r--r--README49
1 files changed, 48 insertions, 1 deletions
diff --git a/README b/README
index 1bafacf..fdc5185 100644
--- a/README
+++ b/README
@@ -1,3 +1,50 @@
-Pica Pica Messenger Node v0.5
+Pica Pica Node and Pica Pica Messenger
+========================
(c) 2012 Anton Sviridenko
+anton@picapica.im
+
+Pica Pica Node serves Pica Pica distributed network. It authenticates users,
+provides info about other existing nodes and online users, routes encrypted
+connections between users. Pica Pica Node is written in C.
+
+Pica Pica Messenger is a graphical IM client written in C++ which uses Qt toolkit.
+
+BUILD
+=========================
+Run ./configure && make install to build and install pica-node and pica-client.
+
+Dependencies:
+ 1) pica-node - OpenSSL libraries (libssl and libcrypto) >=0.9.8,
+SQLite3 library (libsqlite3) and sqlite3 command line client
+
+ 2) pica-client - OpenSSL libraries (libssl and libcrypto) >=0.9.8 and openssl command line tool,
+Qt 4 libraries (QtCore, QtGui, QtSql, QtNetwork), Qt4 tools (uic and moc), pkg-config, xdg-utils (for menu
+item installation)
+
+You can disable building of pica-node or pica-client by passing apropriate option to configure script:
+ --disable-node
+ --disable-client
+
+pica-node:
+By default, Pica Pica sources are configured to be installed in /usr/local prefix. You can override default
+settings using --prefix=[your prefix]. If you are building .rpm, .deb or some other package, it is better to
+use the following settings:
+./configure --prefix=/usr --sysconfdir=/etc --localstatedir=/var
+
+"make install" command installs these important files for pica-node: pica-node.conf with default settings in
+$(sysconfdir), nodelist.db (database with addresses of all existing nodes) in $(localstatedir)/lib/pica-node
+
+After installation it is important to set "announced_addr" parameter in configuration file.
+
+pica-client:
+Alternatively, pica-client.pro project file can be used to build pica-client bypassing autotools stuff. Open
+pica-client.pro in Qt Creator IDE or use QMake to generate Makefile
+
+LICENSE
+=========================
+See LICENSE file
+
+BUGS
+=========================
+Report bugs at http://picapica.im/bugzilla/