| 1 | |
|---|
| 2 | Gobby: First Contact |
|---|
| 3 | _________________________________________________________ |
|---|
| 4 | |
|---|
| 5 | Table of Contents |
|---|
| 6 | 1. Synopsis |
|---|
| 7 | 2. Features |
|---|
| 8 | 3. Installation |
|---|
| 9 | |
|---|
| 10 | 3.1. Dependencies |
|---|
| 11 | |
|---|
| 12 | 4. More information |
|---|
| 13 | |
|---|
| 14 | 4.1. How to report bugs |
|---|
| 15 | 4.2. How to get involved |
|---|
| 16 | |
|---|
| 17 | 5. Licensing |
|---|
| 18 | 6. Development |
|---|
| 19 | |
|---|
| 20 | 1. Synopsis |
|---|
| 21 | |
|---|
| 22 | Gobby is a free collaborative editor. This means that it |
|---|
| 23 | provides you with the possibility to edit files simultaneously |
|---|
| 24 | with other users over a network. The platforms on which you could use |
|---|
| 25 | Gobby are so far Microsoft Windows, Linux, Mac OS X and other |
|---|
| 26 | Unix-like ones. Developed with the GTK+ toolkit it integrates |
|---|
| 27 | nicely into the GNOME desktop environment if you want it to. |
|---|
| 28 | _________________________________________________________ |
|---|
| 29 | |
|---|
| 30 | 2. Features |
|---|
| 31 | |
|---|
| 32 | * Realtime collaboration through encrypted connections |
|---|
| 33 | * Each user has its own colour to be identified by others |
|---|
| 34 | * Local group Undo |
|---|
| 35 | * IRC-like chat |
|---|
| 36 | * Shows cursors and selections of remote users |
|---|
| 37 | * Sidebar with all the others having joined the session |
|---|
| 38 | * Syntax highlighting, auto indentation, configurable tab |
|---|
| 39 | width |
|---|
| 40 | * Multiple documents in one session |
|---|
| 41 | * Document subscriptions |
|---|
| 42 | * Zeroconf support (optional) |
|---|
| 43 | * Unicode support |
|---|
| 44 | * Internationalisation |
|---|
| 45 | * Cross-platform: Microsoft Windows, Linux, Mac OS X, other |
|---|
| 46 | flavours of Unix |
|---|
| 47 | * Free software, licenced under the terms of the GNU General |
|---|
| 48 | Public License |
|---|
| 49 | _________________________________________________________ |
|---|
| 50 | |
|---|
| 51 | 3. Installation |
|---|
| 52 | |
|---|
| 53 | Please see INSTALL for details. |
|---|
| 54 | _________________________________________________________ |
|---|
| 55 | |
|---|
| 56 | 3.1. Dependencies |
|---|
| 57 | |
|---|
| 58 | * libsigc++ (>= 2.0.2) |
|---|
| 59 | * GNUTLS (>= 1.7.2) |
|---|
| 60 | * libinfinity (0.6.x) |
|---|
| 61 | * Gtk+ (>= 2.12.0) |
|---|
| 62 | * Glib (>= 2.18.0) |
|---|
| 63 | * GtkSourceView (>= 2.0) |
|---|
| 64 | * Glibmm (>= 2.18.0) |
|---|
| 65 | * libxml++ (>= 2.6.0) |
|---|
| 66 | * Gtkmm (>= 2.12.0) |
|---|
| 67 | _________________________________________________________ |
|---|
| 68 | |
|---|
| 69 | 4. More information |
|---|
| 70 | |
|---|
| 71 | The development of the obby family is coordinated on its Trac |
|---|
| 72 | project page on http://gobby.0x539.de/. The primary distribution point is |
|---|
| 73 | http://releases.0x539.de/. |
|---|
| 74 | _________________________________________________________ |
|---|
| 75 | |
|---|
| 76 | 4.1. How to report bugs |
|---|
| 77 | |
|---|
| 78 | Bugs could be filed as tickets at http://gobby.0x539.de/trac/newticket or |
|---|
| 79 | submitted directly to us at crew@0x539.de. Please include a |
|---|
| 80 | reachable email address in your bug report as we often need to |
|---|
| 81 | contact the reporters for clarifications. Commonly bugs are |
|---|
| 82 | scheduled for the next major release and will be listed in the |
|---|
| 83 | roadmap. |
|---|
| 84 | _________________________________________________________ |
|---|
| 85 | |
|---|
| 86 | 4.2. How to get involved |
|---|
| 87 | |
|---|
| 88 | We urgently seek all kind of people who could help us in any |
|---|
| 89 | way. Firstly we need documentation writers who could help us |
|---|
| 90 | crafting a help file and some standalone documentation for the |
|---|
| 91 | web. Secondly, if you are skilled in C/C++ programming, we could |
|---|
| 92 | need helping hands with programming. You could use our project |
|---|
| 93 | page as a starting point to look for tickets which need |
|---|
| 94 | fixing. And last, but certainly not least, we need translators |
|---|
| 95 | who get their hands at Gobby's string templates to get it |
|---|
| 96 | localised. Thus more could use Gobby in their native language. |
|---|
| 97 | Just contact us, if in doubt, for more details. |
|---|
| 98 | |
|---|
| 99 | There are also two mailing lists which should provide a mean |
|---|
| 100 | of contact to other Gobby users and to the developers. |
|---|
| 101 | |
|---|
| 102 | * obby-announce: A moderated list used to announce new |
|---|
| 103 | releases of Gobby and its foundation, net6, obby and libinfinity. |
|---|
| 104 | Please refer to |
|---|
| 105 | http://list.0x539.de/mailman/listinfo/obby-announce if you |
|---|
| 106 | want to subscribe it. |
|---|
| 107 | * obby-users: Discussions about Gobby's usage and |
|---|
| 108 | installation problems. The announcements are also posted |
|---|
| 109 | there. Please refer to |
|---|
| 110 | http://list.0x539.de/mailman/listinfo/obby-announce if you |
|---|
| 111 | want to subscribe it. |
|---|
| 112 | _________________________________________________________ |
|---|
| 113 | |
|---|
| 114 | 5. Licensing |
|---|
| 115 | |
|---|
| 116 | This program is written by the 0x539 dev group and is licenced |
|---|
| 117 | under the GNU General Public License (GPL) version 2 or any |
|---|
| 118 | later version. A copy of the license is included in the |
|---|
| 119 | distribution. |
|---|
| 120 | |
|---|
| 121 | This program is distributed in the hope that it will be |
|---|
| 122 | useful, but WITHOUT ANY WARRANTY; without even the implied |
|---|
| 123 | warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR |
|---|
| 124 | PURPOSE. See the GNU General Public License for more details. |
|---|
| 125 | |
|---|
| 126 | Copyright (C) 2005-2009 0x539 dev group <crew@0x539.de> |
|---|
| 127 | |
|---|
| 128 | _________________________________________________________ |
|---|
| 129 | |
|---|
| 130 | 6. Development |
|---|
| 131 | |
|---|
| 132 | To get in contact with the developers, either use the obby-users mailing |
|---|
| 133 | list mentioned above or drop by in our IRC channel #infinote on |
|---|
| 134 | irc.freenode.org. To get the up-to-date Gobby code to hack on, use |
|---|
| 135 | `git clone git://git.0x539.de/git/gobby.git'. Patches should be filed |
|---|
| 136 | in our bug tracker on http://gobby.0x539.de/trac/newticket. |
|---|
