erebion/libervia-backend
Watch
1
0
Fork
You've already forked libervia-backend
 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

README and INSTALL updates

Browse source
This commit is contained in:
Goffi 2014-02-26 00:36:34 +01:00
commit 65958dfc76
2 changed files with 38 additions and 126 deletions
Download patch file Download diff file Expand all files Collapse all files

86
INSTALL
View file

@ -1,87 +1,3 @@
***
Below are the old manual instructions for installation, you can install SàT automatically using easy_install or pip. The full instructions are available on the wiki: http://wiki.goffi.org/wiki/Salut_%C3%A0_Toi
You can install SàT automatically using easy_install or pip, and it is available in several GNU/Linux distributions. The full instructions are available on the wiki: http://wiki.goffi.org/wiki/Salut_%C3%A0_Toi
***
The following instructions are for GNU/Linux operating system. Instruction for other OS will come in the future.
/!\ WARNING /!\
SàT is at a very early developpement stage, and is not intended for end user yet. You need to understand a minimum what you do to install it. Anyway, you can contact me if you need help (but I'm really busy, so don't expect a quick and accurate answer).
** DEPENDENCIES:
To use SàT, you will need to install:
- twisted (http://twistedmatrix.com/trac/) which is found in most distributions, at least core, web and words must be installed
- progressbar (http://pypi.python.org/pypi/progressbar/2.2) which can be installed with easy_install
- wokkel (http://wokkel.ik.nu/). /!\ the MUC branch (http://hg.ik.nu/ralphm/wokkel-muc-client-support-24-2) must be merged, please read instructions below
- wxWidgets (http://www.wxwidgets.org) which is found in most distributions. The more recent the version is, the better.
- urwid (http://excess.org/urwid/) which can be installed with easy_install
- Mutagen (http://code.google.com/p/mutagen/) which can be installed with easy_install
** PATHS:
You must have the main dir (with sat inside) and frontend in your PYTHONPATH. For example, if you have uncompressed the soft in /tmp/useless_soft:
> export PYTHONPATH=$PYTHONPATH:/tmp/useless_soft:/tmp/useless_soft/frontends
if you want to access jp, it can be a good idea to export its dir to your PATH variable:
> export PATH=$PATH:/tmp/useless_soft/frontends/jp
** INSTRUCTIONS:
Here are the instructions for the distribution I use (Kubuntu Karmic Koala), but instructions for other Gnu/Linux distributions must be really close.
To install SàT on a *buntu distribution, you first need to install dependencies:
> sudo aptitude install python-twisted python-twisted-core python-twisted-web python-twisted-words python-wxgtk2.8
You maybe need an updated repository for wxPython, take a look at http://wiki.wxpython.org/InstallingOnUbuntuOrDebian for more informations.
ProgressBar and Urwid can be installed with easy_install, or throught apt:
> sudo aptitude install python-progressbar python-urwid
Wokkel is a bit more complicated to install as we need to merge two branches:
First be sure that mercurial is installed
> sudo aptitude install mercurial
then we go to a directory where we can clone the repositories and merge. If you don't want to code on wokkel, you can do it in /tmp:
> cd /tmp
> hg clone http://hg.ik.nu/wokkel wokkel
now we pull the other branch:
> cd wokkel
> hg pull -f http://hg.ik.nu/ralphm/wokkel-muc-client-support-24-2
time to merge and commit:
> hg merge wokkel-muc-client-support-24
> hg commit -m "Merged wokkel's MUC branch"
finally,we can install:
> sudo python setup.py install
Everything is fine ? Ok let's add the paths.
If you use bash, you need probably to do something like
> echo "export PYTHONPATH=$PYTHONPATH:~/sat:~/sat/frontends" >> ~/.bashrc
> echo "export PATH=$PATH:~/sat/frontends/jp" >> ~/.bashrc
of course, replace ~/sat with the path where you installed SàT, and if you use zsh, replace .bashrc by .zshrc.
Restart a console or export manually the PATH.
Now everything should be OK, you can launch SàT. You have to launch the daemon first:
> cd ~/sat
> ./sat
You should be able to close you console or even X Window if you want.
Then launch one (ore more) frontend. For exemple, to use Wix:
> cd ~/sat/frontends/wix
> ./wix
enjoy =)
And don't hesitate to give feedback.

82
README
View file

@ -5,9 +5,6 @@ SàT v0.3.0
SàT is a XMPP (Jabber) client.
** LICENSE **
SàT is free software: you can redistribute it and/or modify
@ -24,45 +21,32 @@ You should have received a copy of the GNU Affero General Public License
along with SàT. If not, see <http://www.gnu.org/licenses/>.
** ABOUT **
It is currently in a very alpha stage, and absolutely not usable for everyday use, use at your own risks !
** WTF ? **
SàT is a XMPP (Jabber) client, made on a daemon/frontend architecture. Its aim is not only to be an instant messagery client: XMPP offer a lot more, and differents tools will come in the future.
SàT is a XMPP (Jabber) client, made on a daemon/frontends architecture. Its aim is not only to be an instant messaging client: SàT manage microblogging, file transfer, rich text edition, piping over XMPP, XMPP remote, etc.
In addition, SàT has been built with ethic in mind, a social contract show the main lines (see CONTRAT_SOCIAL or CONTRAT_SOCIAL_en). We have a lot of debates about the right way to do things, more on a social way than on a technical way (but consider technic too).
For the moment, the frontends are:
* wix: a wxwidget frontend, the main graphical frontend
* wix: based on WxWidgets, a minimal and old fashioned desktop frontend
* primitivus: a console interface client, for screen lovers
* jp: the command line toolkit. The tool for geeks by geeks
* jp: the powerful command line toolkit.
* libervia: the web frontend. It's in a different package, check libervia on the wiki: http://wiki.goffi.org/wiki/Libervia
* bellaciao: a Qt frontend at an early development stage
other frontends planed in the near future:
* a KDE 4 frontend, as KDE is my main desktop environment
* mobile frontends, fuse frontend, etc.
** HOW TO USE IT ? **
For installation instructions, please read the file "INSTALL". Note that SàT is available in several GNU/Linux distributions
A wiki is available online (http://wiki.goffi.org), in french and english so far (we would appreciate any help for other languages). You can also have a look at the bottom of this files (in contact section) for other availables websites.
** How to use it ? **
For installation instructions, please read the file "INSTALL".
A wiki is available online (http://wiki.goffi.org), in french and english so far (I would appreciate any help for other languages). You can also have a look at the bottom of this files (in contact section) for other availables websites.
SàT is really at an early dev stage, so it's maybe the buggiest software you have ever seen, and there are for the moment absolutely nothing to ease the installation and use (but it will be the case ASAP, one of the goal of the project is the ease of use).
There will probably be a wiki doc in the future.
** Misc **
** MISC **
To use SàT, you need to have D-Bus daemon launched (http://www.freedesktop.org/wiki/Software/dbus/). If you use X Window, it should already be launched. If your are on a terminal environment without X11 (e.g. on a server) you may have to launch it. You can launch a daemon using the following command:
$ eval `dbus-launch --sh-syntax`
@ -95,18 +79,18 @@ http://wiki.goffi.org/wiki/Primitivus
--
SàT is the acronym (yes another one :( ) in tribute to the song Salut à Toi from the Bérurier Noir band. I recommand also the excelent cover from Les Ogres de Barback.
jp stands for "Jabber coPy" or "JumP". If you look well, you can also find my initials ;)
jp stands for "Jabber coPy" or "JumP".
Primitivus is based on Urwid, and, according to their FAQ, "ur" is a german prefix for "ancestral or primal" (primitivus is latin word)
wix come of course from the WX of wxwidgets and just sound cool :).
** /!\ Privacy warning /!\ **
** /!\ PRIVACY WARNING /!\ **
To make setup easier, SàT ask my website (http://www.goffi.org) the external ip address of client. So a request is made to this page: http://www.goffi.org/sat_tools/get_ip.php .
The IP will appear in my private Apache logs (in the same way as IP used to download the software), which are automatically saved, but will not be used. Future releases will probably come with a warning about this and an easy way to avoid it.
To make setup easier, SàT ask a website (http://www.goffi.org) the external ip address of client. So a request is made to this page: http://www.goffi.org/sat_tools/get_ip.php .
The IP will appear in the private Apache logs (in the same way as IP used to download the software), which are automatically saved, but will not be used. Future releases will probably come with a warning about this and an easy way to avoid it.
** Credit **
** CREDIT **
A big big thank to the authors/contributors of...
@ -151,11 +135,12 @@ The Tarot cards pictures come from the deck found on wikicommons (the script use
the powerfull ImageMagick (http://www.imagemagick.org/) is used by the script written to split the previously named picture.
and the others:
and of course, nothing would be possible without Python (http://www.python.org/), Gnu and the Free Software Foundation (http://www.gnu.org, http://www.fsf.org/), the Linux Kernel (http://www.kernel.org/), and the coder of the tools I use like Vim (http://www.vim.org/), Mercurial (http://www.selenic.com/mercurial/wiki/), or all the KDE stuff (http://www.kde.org/ and of course http://amarok.kde.org/), and also XFCE (http://www.xfce.org), etc. Thanks thanks thanks, thank to everybody in the Free (Libre) chain for making a part of the dream.
and of course, nothing would be possible without Python (http://www.python.org/), GNU and the Free Software Foundation (http://www.gnu.org, http://www.fsf.org/), the Linux Kernel (http://www.kernel.org/), and the coder of the tools I use like Vim (http://www.vim.org/), Mercurial (http://www.selenic.com/mercurial/wiki/), or all the KDE stuff (http://www.kde.org/ and of course http://amarok.kde.org/), and also XFCE (http://www.xfce.org), etc. Thanks thanks thanks, thanks to everybody in the Free (Libre) chain for making a part of the dream.
If I forgot any credit (and I probably have), please contact me (mail below) to fix it.
** Contributors **
** CONTRIBUTORS **
Salut à Toi has received contributions from:
@ -175,18 +160,29 @@ Many thanks to them.
A big thanks also to all the maintainers of SàT packages
** Contact **
You can contact me on goffi@goffi.org (e-mail) or goffi@jabber.fr (jid)
You'll find the latest version and other stuffs on my *.goffi.org websites:
- presentation (sat.goffi.org) the project presentation site
** CONTACT **
You can join us on the XMPP MUC room (sat@chat.jabberfr.org), or individually:
Goffi:
- goffi@goffi.org (e-mail)
- goffi@jabber.fr (jid)
- http://www.goffi.org (blog, with fresh news about SàT)
Souliane:
- souliane@mailoo.org (e-mail)
- souliane@libervia.org (jid)
You'll find the latest version and other stuffs on *.goffi.org websites:
- wiki (wiki.goffi.org), in french & english so far
- ftp (ftp.goffi.org) for the latest version, or previous ones (and other projects)
- blog (www.goffi.org) for latest news (in french)
- bugtracker (bugs.goffi.org) to report any problem or give suggestions
- various mailing lists (lists.goffi.org) are about to be created
- mailing lists (lists.goffi.org)
and the official SàT website is at http://www.salut-a-toi.org
This software is dedicated to Roger Poisson.