Misc. minor fixes, improvements and updates

This commit is contained in:
Yorhel 2013-02-20 11:22:52 +01:00
parent 2e29709225
commit 94ae88d4b9
10 changed files with 89 additions and 34 deletions

View file

@ -22,25 +22,33 @@ There are no tarballs at the moment. You'll have to get it from the git repo:
autoreconf -i
./configure
make
sudo make install
When doing a C<git pull> to update your version later on, make sure to follow
up with a C<git submodule update> to get the right dependencies, too.
The git repo is available for
L<online browsing|http://g.blicky.net/globster.git/> and can also be
L<found on github|https://github.com/yorhel/globster>.
(Note: If you have a git version before 1.6.5, the C<--recursive> argument
isn't going to work. You'll have to type C<git submodule init> and C<git
submodule update> after checking out the repo. But chances are that your GnuTLS
is waaay too old as well and Globster won't currently build, anyway.)
=head2 Requirements
Globster can be compiled with a (moderately recent) GCC or clang. You'll need
the following libraries: L<libdbus|http://dbus.freedesktop.org/> and
L<GnuTLS|http://gnutls.org> 3.0+.
L<GnuTLS|http://gnutls.org>. If your GnuTLS is too old (<= 2.12), you also need
libgcrypt. The globsterctl script requires Perl and the Net::DBus module.
On Debian and Ubuntu, that boils down to the following:
apt-get install git make gcc libc-dev automake autoconf\
pkg-config libdbus-1-dev libgnutls-dev libnet-dbus-perl
And for Arch Linux:
pacman -S base-devel perl-net-dbus
I've only tested things on Linux (glibc and L<musl|http://www.musl-libc.org>),
but I intent to support more kinda-sane POSIX systems in the future as well.
The requirement of GnuTLS 3.0+ will be relaxed later on. On the other hand,
Globster will no doubt require some more libraries as more basic features are
being implemented. And, yes, I<of course> we will get static binaries!
@ -71,10 +79,22 @@ to join the development hub and bug me for help: C<adc://dc.blicky.net:2780/>.
I did already write some
L<API documentation|http://dev.yorhel.nl/globster/api>.
There are at this point no scripts or interfaces for Globster available. I'd
love to have at least a simple console client (a weechat or irssi plugin?) and
perhaps a web-based interface. But other solutions are nice, too. Who's going
to write all that, you ask? Erm... well... You, perhaps? :-)
There are at this point not many scripts or interfaces available for Globster:
=over
=item * L<globsterctl|http://dev.yorhel.nl/globster/ctl> - A control script for the daemon, included in the git repo.
=item * L<globster-feedspam.pl|http://p.blicky.net/wpaaf> - An RSS / Atom notification script.
=item * L<globster-mhc.pl|http://p.blicky.net/8y8mv> - A hub chat link script. More useful as an example than anything else.
=back
There's more to come. I'd love to have at least a convenient console client (a
weechat or irssi plugin? An ncdc fork?) and perhaps a web-based interface. But
other stuff is welcome, too. Who's going to write all that, you ask? Erm...
well... You, perhaps? :-)
=head2 Final notes
@ -83,7 +103,6 @@ and available under a liberal MIT license.
Globster incorporates code from
L<libev|http://software.schmorp.de/pkg/libev.html>,
L<libeio|http://software.schmorp.de/pkg/libeio.html>,
L<freetiger|http://klondike.es/freetiger/>,
L<klib|https://github.com/attractivechaos/klib> and
L<ylib|https://github.com/yorhel/ylib>.