doc/README

   1 /* logjam, a GTK LiveJournal client.
   2  * Copyright (C) 2000-2003 Evan Martin <martine@cs.washington.edu>
   3  */
   4
   5 Introduction
   6 ------------
   7 "LiveJournal.com... because you like to think other people care."
   8 LogJam is a client for LiveJournal.  It lets you post, edit old
   9 entries, manage your friends, and whatever other useful
  10 LiveJournal-related features we can think of.
  11
  12 Visit http://logjam.danga.com for the latest version and up-to-date
  13 information about LogJam development.
  14
  15
  16 Requirements
  17 ------------
  18 LogJam requires GTK+ 2.0 or greater.
  19 Get GTK+ at http://www.gtk.org.
  20
  21 LogJam also requires libcurl, an HTTP library.
  22
  23 Debian users need libgtk2.0-dev, libxml2-dev, libcurl-dev, and their
  24 dependencies.
  25
  26 RPMs of libcurl are linked from the LogJam page.
  27
  28
  29 Enhancements
  30 ------------
  31 None of these enhancements are required to build LogJam.
  32 LogJam should detect whether you have them at configure-time and
  33 conditionally enable them.
  34
  35  - Spell checking support requires GtkSpell 2.0.2 or later.
  36    For more information about GtkSpell, visit http://gtkspell.sf.net.
  37
  38  - Current music autodetection requires XMMS 1.2 or later.
  39    Visit http://www.xmms.org.
  40
  41  - HTML preview requires libGtkHTML 3.  This is the HTML widget used by
  42    Ximian's evolution, so it shouldn't be hard to find.
  43
  44 Debian users can apt-get libgtkspell-dev, xmms-dev, libgtkhtml3-dev, and
  45 their dependencies.
  46
  47
  48 Getting Started
  49 ---------------
  50 You need a LiveJournal account to use LogJam.
  51 LogJam cannot create this.  Visit http://www.livejournal.com to get
  52 an account.
  53
  54 (LogJam can also be used with alternative LiveJournal sites, though
  55 you'll have to find them yourself.)
  56
  57 LogJam has a pretty standard setup.
  58 Running:
  59         $ ./configure
  60         $ make
  61         $ su
  62         # make install
  63 should be all you need to install it.
  64
  65 The installed executable is called "logjam".
  66
  67
  68 Using LogJam
  69 ------------
  70 Most of LogJam should be self-explanatory.  That's why you're using a
  71 GUI, right?
  72
  73 GTK Accelerators:
  74 You can remap the accelerators for any menu item.  To do it, first
  75 enable the accelerator-changing functionality in GTK by appending this
  76 line to ~/.gtkrc-2.0:
  77   gtk-can-change-accels = 1
  78 or, on a GNOME system, with this command:
  79   gconftool-2 -s /desktop/gnome/interface/can_change_accels -t bool true
  80 Then open up a menu in LogJam, move the mouse over a menu item, and type
  81 a keystroke to bind that menu item to that keystroke.  (To clear an
  82 accelerator, hit backspace.)
  83
  84 Unicode characters:
  85 LiveJournal, LogJam, and GTK2 all support unicode, so LogJam is capable of
  86 posting in almost any language you can find.  Additionally, many
  87 characters that are not part of the ASCII standard (such as an em-dash)
  88 are available.  Please visit my page on X input:
  89   http://neugierig.org/content/input/
  90 for details on configuring this.
  91
  92
  93 Also:
  94 If there is anything you don't like about LogJam, don't just complain
  95 about it in your LiveJournal, tell me!  I can't fix it if I don't know
  96 about it.
  97
  98
  99
 100 Authors
 101 -------
 102 Evan Martin (LiveJournal user "evan") -- http://neugierig.org
 103 wrote most of this.
 104
 105 Gaal Yahas (LiveJournal user "gaal") -- http://www.forum2.org/gaal/
 106 has made some significant contributions.
 107
 108
 109 Thanks
 110 ------
 111 In more or less unsorted order, but the more recent contributions
 112 are at the top:
 113
 114 Aleksander Adamowski <aleksander.adamowski@gmail.com> - patches
 115 Satoru SATOH <ss@gnome.gr.jp> - Japanese translation
 116 Grigory Bakunov <black@asplinux.ru> - Russian translation
 117 The GEdit Authors - Undo code
 118 Frank Hofmann <frankhofmann@gmx.ch> - German translation
 119 George Mason <georgemason@mindspring.com> - accelerator saving
 120 Dave Spadea <dave@spadea.net> - lj-cut patch
 121 Dmitry "old_one" Dyomin <old@old.com.ua> - Ukrainian translation
 122 Ricardo "mones" Mones Lastra <ricardo.mones@hispalinux.es> - Spanish translation
 123 Jon Nall <nall@gentoo.org> - Gentoo packaging
 124 Mikhail Chekanov <mihun@bitex.com> - Russian translation
 125 Asaf "ijon" Bartov <ijon@forum2.org> - win32 multithread support
 126 Gaal "gaal" Yahas <gaal@forum2.org> - checkfriends, poll creator, i18n
 127 Sergei "sgt" Barbarash <sgt@fep.ru> - support for cyrillic translation
 128 Michael Bravo <mbravo@tag-ltd.spb.ru> - locale fixes
 129 Ari Pollak <ari@debian.org> - Debian package, undo
 130 Steve Bernacki, Jr. <steve@copacetic.net> - typo in configure.in
 131 Artem Baguinski <artm@v2.nl> - locale setting
 132 nulld <nulld@encryptedemail.net> - OpenBSD box to test on
 133 Decklin "decklin" Foster <decklin@red-bean.com> - window geometry save/restore
 134 Matthew Vernon <matthew@pick.ucam.org> - simple login proxy patch
 135 Bill Crawford <bill@eb0ne.net> - variety of patches
 136 Gabriel "diamondc" Martinez <gabrielfm@yahoo.com> - Solaris box to test on
 137 Tom "spot" Callaway <spot@redhat.com> - Advanced RPM packaging
 138 Alexander Gräfe <nachtfalke@retrogra.de> - Initial RPM packaging
 139 Christian "christian" Surchi <csurchi@debian.org> - Debian maintainer
 140 Joe "piman" Wreschnig <piman@sacredchao.net> - Debian package help
 141 Ryan Younce <ryan@manunkind.org> - FreeBSD packaging
 142 Raja Mukerji <mukerji@pobox.com> - a multitude of patches
 143 Adam Bidema <hijinx@klone.nwraves.net> - initial file save patch
 144 Matt Roper <mdroper@ucdavis.edu> - parallel make tips
 145 Brad Fitzpatrick <brad@danga.com> - much of the original client
 146
 147 And these people helped so long ago, I can't remember why they're
 148 even listed here:
 149 Simon Huet <detourds@bellsouth.net>
 150 Scott Hammack <shammack@goldinc.com>
 151 Damian Bickhoff <q9405096@brampton.cqu.edu.au>
 152
 153 License
 154 -------
 155 This program is free software; you can redistribute it and/or modify
 156 it under the terms of the GNU General Public License as published by
 157 the Free Software Foundation; either version 2 of the License, or
 158 (at your option) any later version.
 159
 160 This program is distributed in the hope that it will be useful,
 161 but WITHOUT ANY WARRANTY; without even the implied warranty of
 162 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 163 GNU General Public License for more details.
 164
 165 You should have received a copy of the GNU General Public License
 166 along with this program; if not, write to the Free Software
 167 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 168
 169 vim:tw=72