From: Manuel Nickschas <sputnick@quassel-irc.org>
Date: Fri, 19 Oct 2007 14:29:51 +0000 (+0000)
Subject: docs++
X-Git-Tag: 0.1.0~119
X-Git-Url: https://git.quassel-irc.org/?p=quassel.git;a=commitdiff_plain;h=b9d814b020bbcf24100d79a7a6a2fcf37ebec2db

docs++
---

diff --git a/INSTALL b/INSTALL
new file mode 100644
index 00000000..ad114913
--- /dev/null
+++ b/INSTALL
@@ -0,0 +1,26 @@
+These are preliminary instructions, until we get the config more polished.
+
+To build Quassel IRC, cd to build/ and run qmake && make. This builds all three
+versions of Quassel. You may choose individual targets by setting qmakes BUILD
+variable:
+
+qmake BUILD=<foo>
+
+where <foo> is any combination of qtclient, core, mono or all. Note that in order
+to change this later, you will have to make distclean, otherwise the BUILD setting
+seems to be ignored by qmake.
+
+After running make, you will find the binaries in build/targets.
+
+NOTE: As of now, quassel needs the directory $HOME/.quassel to exist prior to first
+      run, otherwise it cannot create its database! This will be changed soon, but
+      for now, you will just need to create this directory.
+
+The core-side database will be created automatically. A user named 'Default' with
+the password 'password' will be created, so in order to connect to the core, you
+need to enter this information. The core listens on port 4242 for incoming connections.
+
+Please also do read the README file.
+
+Thanks,
+~ The Quassel IRC Team
diff --git a/README b/README
new file mode 100644
index 00000000..50605dc5
--- /dev/null
+++ b/README
@@ -0,0 +1,22 @@
+Quassel IRC - Release Notes
+===========================
+
+This is a pre-release version. This means that a lot of stuff is not working
+yet, that copyright notices and licensing information are not always correct,
+and that stuff generelly breaks. We kindly ask you that you don't give out the
+source code or svn account information before the first public release. If you
+know interested persons, please point them to us and we will gladly make the
+source code available to them.
+
+Please don't hesitate to inform us about bugs you encounter (but you probably
+don't need to report obviously missing features such as a working topic bar
+or nicklist, we know that ourselves ;-)).
+
+The Quassel IRC Team can be contacted on Freenode/#quassel (or #quassel.de).
+We always welcome new users in our channels!
+
+The bugtracker can be found at <http://bugs.quassel-irc.org>.
+The dev team can be reached by email: devel@quassel-irc.org
+
+Thanks,
+~ The Quassel IRC Team