From: Marcus Eggenberger Date: Sun, 2 Dec 2007 23:42:43 +0000 (+0000) Subject: minor changes to the docs X-Git-Tag: 0.1.0~39 X-Git-Url: https://git.quassel-irc.org/?p=quassel.git;a=commitdiff_plain;h=8f124bf55d262a83580dc569f7d62da8b25b6177 minor changes to the docs --- diff --git a/INSTALL b/INSTALL index 5d76c0ca..17d1310d 100644 --- a/INSTALL +++ b/INSTALL @@ -1,26 +1,34 @@ -These are preliminary instructions, until we get the config more polished. +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: +Quassel IRC features three binaries: quasselcore, quasselclient, and +quassel. While quasselcore and quasselclient obviously provide the +separated core and client functionality, the latter one (quassel) is a +monolithic version containing both of them for convenience. + +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= -where 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. +where 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. -make install will probably do something, but it has never been tried and may destroy -your system or kill a kitten. It's not necessary anyway, since there are no installable -files other than the binaries. Though this might change in later releases. - -On first run of the Quassel core, it will wait for a client to connect and present a -(preliminary) first-run wizard. This will allow you to create the database and one -admin user for the core-side storage. Note that Quassel does not support the -administration of user accounts yet, this includes adding more users, changing passwords -and so on. This is high on our TODO list, of course. +make install will probably do something, but it has never been tried +and may destroy your system or kill a kitten. It's not necessary +anyway, since there are no installable files other than the +binaries. Though this might change in later releases. + +On first run of the Quassel core, it will wait for a client to connect +and present a (preliminary) first-run wizard. This will allow you to +create the database and one admin user for the core-side storage. Note +that Quassel does not support the administration of user accounts yet, +this includes adding more users, changing passwords and so on. This is +high on our TODO list, of course. Please also do read the README file. diff --git a/INSTALL.Qtopia b/INSTALL.Qtopia index 36121a6b..a7ec6f59 100644 --- a/INSTALL.Qtopia +++ b/INSTALL.Qtopia @@ -1,6 +1,5 @@ -We assume that you are familiar with application development on -the Greenphone (or other Qtopia devices), so we won't go into -detail here. +We assume that you are familiar with application development on the +Greenphone (or other Qtopia devices), so we won't go into detail here. The project file and related resources for QuasselTopia are to be found in qtopia-build/. Set up your development environment as usual (i.e. have @@ -10,8 +9,8 @@ cd qtopia-build qtopiamake make -This will build the binary called 'quasseltopia' in the build directory. -Then use the gph script to build and deploy the package: +This will build the binary called 'quasseltopia' in the build +directory. Then use the gph script to build and deploy the package: gph -p gph -i diff --git a/README b/README index cbf78c62..e8179c78 100644 --- a/README +++ b/README @@ -1,25 +1,27 @@ 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. +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 generally 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 ;-) +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 ;-) -On first run of the Quassel core, it will wait for a client to connect and present a -(preliminary) first-run wizard. This will allow you to create the database and one -admin user for the core-side storage. Note that Quassel does not support the -administration of user accounts yet, this includes adding more users, changing passwords -and so on. This is high on our TODO list, of course. +On first run of the Quassel core, it will wait for a client to connect +and present a (preliminary) first-run wizard. This will allow you to +create the database and one admin user for the core-side storage. Note +that Quassel does not support the administration of user accounts yet, +this includes adding more users, changing passwords and so on. This is +high on our TODO list, of course. -The Quassel IRC Team can be contacted on Freenode/#quassel (or #quassel.de). -We always welcome new users in our channels! +The Quassel IRC Team can be contacted on Freenode/#quassel (or +#quassel.de). We always welcome new users in our channels! Our homepage is . The bugtracker can be found at . diff --git a/README.Qtopia b/README.Qtopia index f2b5df80..96c0cf3a 100644 --- a/README.Qtopia +++ b/README.Qtopia @@ -12,27 +12,30 @@ Of course, QuasselTopia might well run on other Qtopia-enabled devices as well; it's just not tested yet. We will eventually support general Qtopia devices as well. -Note that QuasselTopia is just the client; it can't do IRC by itself. You'll -need a Quassel core running on some server or PC for the phone to connect to. - -For testing purposes we have provided a core on one of our servers. You can -connect to it for checking out QuasselTopia without having to install your own. -The core can be reached at , with user 'testuser' -and password 'testuser'. If you can't connect, please let us know, and we'll -restart it. You may also connect with a Quassel desktop client to this core. -The test account will be automatically created on first run. - -In its current state, QuasselTopia cannot do much except for connecting -to a core and displaying the buffers you are in. Oh, and chatting of course. -But you cannot change any settings, create/edit identities or networks, -you can't even connect to a network from the Greenphone. So in order to test -QuasselTopia, it's a good idea to have a desktop Quassel client connected -at the same time, so that you can do these things from your PC. - -QuasselTopia thus is in a very early state, merely a proof of concept rather -than something for day-to-day use. It shows already though that a mobile -Quassel version is feasible and usable, and QuasselTopia will evolve together -with the desktop version. +Note that QuasselTopia is just the client; it can't do IRC by +itself. You'll need a Quassel core running on some server or PC for +the phone to connect to. + +For testing purposes we have provided a core on one of our +servers. You can connect to it for checking out QuasselTopia without +having to install your own. The core can be reached at +, with user 'testuser' and password +'testuser'. If you can't connect, please let us know, and we'll +restart it. You may also connect with a Quassel desktop client to this +core. The test account will be automatically created on first run. + +In its current state, QuasselTopia cannot do much except for +connecting to a core and displaying the buffers you are in. Oh, and +chatting of course. But you cannot change any settings, create/edit +identities or networks, you can't even connect to a network from the +Greenphone. So in order to test QuasselTopia, it's a good idea to have +a desktop Quassel client connected at the same time, so that you can +do these things from your PC. + +QuasselTopia thus is in a very early state, merely a proof of concept +rather than something for day-to-day use. It shows already though that +a mobile Quassel version is feasible and usable, and QuasselTopia will +evolve together with the desktop version. We still hope you have fun!