annotate README4PACKAGERS @ 889:9cce5b42a134

we are in a dev version again...
author Goffi <goffi@goffi.org>
date Sat, 01 Mar 2014 13:35:21 +0100
parents 3a943b5f2cec
children 0199a17f4d92
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
872
a650f01737d7 added README4PACKAGERS
souliane <souliane@mailoo.org>
parents:
diff changeset
1 First of all, thank you for packaging SàT :)
a650f01737d7 added README4PACKAGERS
souliane <souliane@mailoo.org>
parents:
diff changeset
2
873
36572b0a56e6 README4PACKAGERS update
Goffi <goffi@goffi.org>
parents: 872
diff changeset
3 You will find below the list of dependencies for the backend and the frontends, and some other infos.
872
a650f01737d7 added README4PACKAGERS
souliane <souliane@mailoo.org>
parents:
diff changeset
4
a650f01737d7 added README4PACKAGERS
souliane <souliane@mailoo.org>
parents:
diff changeset
5 ############################
a650f01737d7 added README4PACKAGERS
souliane <souliane@mailoo.org>
parents:
diff changeset
6 List of general dependencies
a650f01737d7 added README4PACKAGERS
souliane <souliane@mailoo.org>
parents:
diff changeset
7 ############################
a650f01737d7 added README4PACKAGERS
souliane <souliane@mailoo.org>
parents:
diff changeset
8
a650f01737d7 added README4PACKAGERS
souliane <souliane@mailoo.org>
parents:
diff changeset
9 Python 2.7
a650f01737d7 added README4PACKAGERS
souliane <souliane@mailoo.org>
parents:
diff changeset
10 dbus-python
a650f01737d7 added README4PACKAGERS
souliane <souliane@mailoo.org>
parents:
diff changeset
11
a650f01737d7 added README4PACKAGERS
souliane <souliane@mailoo.org>
parents:
diff changeset
12 ####################################
a650f01737d7 added README4PACKAGERS
souliane <souliane@mailoo.org>
parents:
diff changeset
13 List of dependencies for SàT backend
a650f01737d7 added README4PACKAGERS
souliane <souliane@mailoo.org>
parents:
diff changeset
14 ####################################
a650f01737d7 added README4PACKAGERS
souliane <souliane@mailoo.org>
parents:
diff changeset
15
a650f01737d7 added README4PACKAGERS
souliane <souliane@mailoo.org>
parents:
diff changeset
16 lxml
a650f01737d7 added README4PACKAGERS
souliane <souliane@mailoo.org>
parents:
diff changeset
17 Mutagen
a650f01737d7 added README4PACKAGERS
souliane <souliane@mailoo.org>
parents:
diff changeset
18 PIL
a650f01737d7 added README4PACKAGERS
souliane <souliane@mailoo.org>
parents:
diff changeset
19 PyFeed
a650f01737d7 added README4PACKAGERS
souliane <souliane@mailoo.org>
parents:
diff changeset
20 Twisted Core
a650f01737d7 added README4PACKAGERS
souliane <souliane@mailoo.org>
parents:
diff changeset
21 Twisted Mail
a650f01737d7 added README4PACKAGERS
souliane <souliane@mailoo.org>
parents:
diff changeset
22 Twisted Web
a650f01737d7 added README4PACKAGERS
souliane <souliane@mailoo.org>
parents:
diff changeset
23 Twisted Words
a650f01737d7 added README4PACKAGERS
souliane <souliane@mailoo.org>
parents:
diff changeset
24 Wokkel
a650f01737d7 added README4PACKAGERS
souliane <souliane@mailoo.org>
parents:
diff changeset
25 xe
883
3a943b5f2cec README4PACKAGERS fixes
Goffi <goffi@goffi.org>
parents: 873
diff changeset
26 zope.interface
872
a650f01737d7 added README4PACKAGERS
souliane <souliane@mailoo.org>
parents:
diff changeset
27
883
3a943b5f2cec README4PACKAGERS fixes
Goffi <goffi@goffi.org>
parents: 873
diff changeset
28 Recommandation: markdown, html2text
872
a650f01737d7 added README4PACKAGERS
souliane <souliane@mailoo.org>
parents:
diff changeset
29
a650f01737d7 added README4PACKAGERS
souliane <souliane@mailoo.org>
parents:
diff changeset
30 ####################################
a650f01737d7 added README4PACKAGERS
souliane <souliane@mailoo.org>
parents:
diff changeset
31 List of dependencies for Jp frontend
a650f01737d7 added README4PACKAGERS
souliane <souliane@mailoo.org>
parents:
diff changeset
32 ####################################
a650f01737d7 added README4PACKAGERS
souliane <souliane@mailoo.org>
parents:
diff changeset
33
a650f01737d7 added README4PACKAGERS
souliane <souliane@mailoo.org>
parents:
diff changeset
34 GObject
883
3a943b5f2cec README4PACKAGERS fixes
Goffi <goffi@goffi.org>
parents: 873
diff changeset
35 Recommandation: progressbar
872
a650f01737d7 added README4PACKAGERS
souliane <souliane@mailoo.org>
parents:
diff changeset
36
a650f01737d7 added README4PACKAGERS
souliane <souliane@mailoo.org>
parents:
diff changeset
37 ############################################
a650f01737d7 added README4PACKAGERS
souliane <souliane@mailoo.org>
parents:
diff changeset
38 List of dependencies for Primitivus frontend
a650f01737d7 added README4PACKAGERS
souliane <souliane@mailoo.org>
parents:
diff changeset
39 ############################################
a650f01737d7 added README4PACKAGERS
souliane <souliane@mailoo.org>
parents:
diff changeset
40
a650f01737d7 added README4PACKAGERS
souliane <souliane@mailoo.org>
parents:
diff changeset
41 Urwid
a650f01737d7 added README4PACKAGERS
souliane <souliane@mailoo.org>
parents:
diff changeset
42 Urwid-satext
a650f01737d7 added README4PACKAGERS
souliane <souliane@mailoo.org>
parents:
diff changeset
43
a650f01737d7 added README4PACKAGERS
souliane <souliane@mailoo.org>
parents:
diff changeset
44 Suggestion: Python X Library
a650f01737d7 added README4PACKAGERS
souliane <souliane@mailoo.org>
parents:
diff changeset
45
a650f01737d7 added README4PACKAGERS
souliane <souliane@mailoo.org>
parents:
diff changeset
46 #####################################
a650f01737d7 added README4PACKAGERS
souliane <souliane@mailoo.org>
parents:
diff changeset
47 List of dependencies for Wix frontend
a650f01737d7 added README4PACKAGERS
souliane <souliane@mailoo.org>
parents:
diff changeset
48 #####################################
a650f01737d7 added README4PACKAGERS
souliane <souliane@mailoo.org>
parents:
diff changeset
49
a650f01737d7 added README4PACKAGERS
souliane <souliane@mailoo.org>
parents:
diff changeset
50 wxPython
a650f01737d7 added README4PACKAGERS
souliane <souliane@mailoo.org>
parents:
diff changeset
51
a650f01737d7 added README4PACKAGERS
souliane <souliane@mailoo.org>
parents:
diff changeset
52
873
36572b0a56e6 README4PACKAGERS update
Goffi <goffi@goffi.org>
parents: 872
diff changeset
53 ##################
36572b0a56e6 README4PACKAGERS update
Goffi <goffi@goffi.org>
parents: 872
diff changeset
54 Satellite projects
36572b0a56e6 README4PACKAGERS update
Goffi <goffi@goffi.org>
parents: 872
diff changeset
55 ##################
36572b0a56e6 README4PACKAGERS update
Goffi <goffi@goffi.org>
parents: 872
diff changeset
56
36572b0a56e6 README4PACKAGERS update
Goffi <goffi@goffi.org>
parents: 872
diff changeset
57 Several project have been made around SàT, they are all available at http://repos.goffi.org:
36572b0a56e6 README4PACKAGERS update
Goffi <goffi@goffi.org>
parents: 872
diff changeset
58
36572b0a56e6 README4PACKAGERS update
Goffi <goffi@goffi.org>
parents: 872
diff changeset
59 - Libervia: the both Ajax and static web frontend
36572b0a56e6 README4PACKAGERS update
Goffi <goffi@goffi.org>
parents: 872
diff changeset
60
36572b0a56e6 README4PACKAGERS update
Goffi <goffi@goffi.org>
parents: 872
diff changeset
61 - SàT PubSub: a PubSub service which manage experimental features like fine permission tuning
36572b0a56e6 README4PACKAGERS update
Goffi <goffi@goffi.org>
parents: 872
diff changeset
62
36572b0a56e6 README4PACKAGERS update
Goffi <goffi@goffi.org>
parents: 872
diff changeset
63 - SàT media: Media needed to by the frontends
36572b0a56e6 README4PACKAGERS update
Goffi <goffi@goffi.org>
parents: 872
diff changeset
64
36572b0a56e6 README4PACKAGERS update
Goffi <goffi@goffi.org>
parents: 872
diff changeset
65 - Urwid SàText: Widgets for urwid library, designed for SàT but can be useful for other projects. Mandatory for Primitivus
883
3a943b5f2cec README4PACKAGERS fixes
Goffi <goffi@goffi.org>
parents: 873
diff changeset
66
873
36572b0a56e6 README4PACKAGERS update
Goffi <goffi@goffi.org>
parents: 872
diff changeset
67 ## Folowing ones are not needed in a distribution, because there are in a too early stage of development, or not useful for general purpose ##
36572b0a56e6 README4PACKAGERS update
Goffi <goffi@goffi.org>
parents: 872
diff changeset
68
36572b0a56e6 README4PACKAGERS update
Goffi <goffi@goffi.org>
parents: 872
diff changeset
69 - Bellaciao: a Qt frontend, at an early stage of development
36572b0a56e6 README4PACKAGERS update
Goffi <goffi@goffi.org>
parents: 872
diff changeset
70
36572b0a56e6 README4PACKAGERS update
Goffi <goffi@goffi.org>
parents: 872
diff changeset
71 - Salut: a XMPP directory, at a very early stage of development
36572b0a56e6 README4PACKAGERS update
Goffi <goffi@goffi.org>
parents: 872
diff changeset
72
36572b0a56e6 README4PACKAGERS update
Goffi <goffi@goffi.org>
parents: 872
diff changeset
73 - SàT Website: the code of the website
36572b0a56e6 README4PACKAGERS update
Goffi <goffi@goffi.org>
parents: 872
diff changeset
74
36572b0a56e6 README4PACKAGERS update
Goffi <goffi@goffi.org>
parents: 872
diff changeset
75
36572b0a56e6 README4PACKAGERS update
Goffi <goffi@goffi.org>
parents: 872
diff changeset
76 ########
36572b0a56e6 README4PACKAGERS update
Goffi <goffi@goffi.org>
parents: 872
diff changeset
77 Licences
36572b0a56e6 README4PACKAGERS update
Goffi <goffi@goffi.org>
parents: 872
diff changeset
78 ########
36572b0a56e6 README4PACKAGERS update
Goffi <goffi@goffi.org>
parents: 872
diff changeset
79
36572b0a56e6 README4PACKAGERS update
Goffi <goffi@goffi.org>
parents: 872
diff changeset
80 We are careful about the licences we use. Our projects are licenced as follow:
36572b0a56e6 README4PACKAGERS update
Goffi <goffi@goffi.org>
parents: 872
diff changeset
81
36572b0a56e6 README4PACKAGERS update
Goffi <goffi@goffi.org>
parents: 872
diff changeset
82 - Libervia, SàT PubSub, Bellaciao, Salut, SàT Website: AGPL v3+
883
3a943b5f2cec README4PACKAGERS fixes
Goffi <goffi@goffi.org>
parents: 873
diff changeset
83
873
36572b0a56e6 README4PACKAGERS update
Goffi <goffi@goffi.org>
parents: 872
diff changeset
84 - Urwid SàText: LGPL v3+
883
3a943b5f2cec README4PACKAGERS fixes
Goffi <goffi@goffi.org>
parents: 873
diff changeset
85
873
36572b0a56e6 README4PACKAGERS update
Goffi <goffi@goffi.org>
parents: 872
diff changeset
86 When an external code is included (portion or library), we indicate the source and the licence, and we are careful to take Libre licences only. If we have a mistake somewhere, please let us know.
36572b0a56e6 README4PACKAGERS update
Goffi <goffi@goffi.org>
parents: 872
diff changeset
87
36572b0a56e6 README4PACKAGERS update
Goffi <goffi@goffi.org>
parents: 872
diff changeset
88 The case of SàT Media is particular are there is a compilation of media from severals sources. SàT Logo was made by Adrien Vigneron and is under CC By-SA. Other works are all under Free licences, licences are specified in the base directory of each package.
36572b0a56e6 README4PACKAGERS update
Goffi <goffi@goffi.org>
parents: 872
diff changeset
89
872
a650f01737d7 added README4PACKAGERS
souliane <souliane@mailoo.org>
parents:
diff changeset
90
873
36572b0a56e6 README4PACKAGERS update
Goffi <goffi@goffi.org>
parents: 872
diff changeset
91 #####################
36572b0a56e6 README4PACKAGERS update
Goffi <goffi@goffi.org>
parents: 872
diff changeset
92 Packages and versions
36572b0a56e6 README4PACKAGERS update
Goffi <goffi@goffi.org>
parents: 872
diff changeset
93 #####################
36572b0a56e6 README4PACKAGERS update
Goffi <goffi@goffi.org>
parents: 872
diff changeset
94
36572b0a56e6 README4PACKAGERS update
Goffi <goffi@goffi.org>
parents: 872
diff changeset
95 We have packaged Wix, Primitivus, and jp with the core backend, as we thing theses frontends should be shipped with each SàT distribution. But it would be nice to allow the use to install them separately: Wix will be useless for a server.
36572b0a56e6 README4PACKAGERS update
Goffi <goffi@goffi.org>
parents: 872
diff changeset
96
36572b0a56e6 README4PACKAGERS update
Goffi <goffi@goffi.org>
parents: 872
diff changeset
97 Libervia is on its all package because of its specificities (it's a huge project by itself, it use Pyjamas Python => JS Compiler, etc). But it's a part of the same project.
36572b0a56e6 README4PACKAGERS update
Goffi <goffi@goffi.org>
parents: 872
diff changeset
98
36572b0a56e6 README4PACKAGERS update
Goffi <goffi@goffi.org>
parents: 872
diff changeset
99 All the official frontends have the same version, which is the version of the backend they use.
36572b0a56e6 README4PACKAGERS update
Goffi <goffi@goffi.org>
parents: 872
diff changeset
100
36572b0a56e6 README4PACKAGERS update
Goffi <goffi@goffi.org>
parents: 872
diff changeset
101
36572b0a56e6 README4PACKAGERS update
Goffi <goffi@goffi.org>
parents: 872
diff changeset
102 #######
36572b0a56e6 README4PACKAGERS update
Goffi <goffi@goffi.org>
parents: 872
diff changeset
103 Updates
36572b0a56e6 README4PACKAGERS update
Goffi <goffi@goffi.org>
parents: 872
diff changeset
104 #######
36572b0a56e6 README4PACKAGERS update
Goffi <goffi@goffi.org>
parents: 872
diff changeset
105
36572b0a56e6 README4PACKAGERS update
Goffi <goffi@goffi.org>
parents: 872
diff changeset
106 There is a sqlite database per user (default in ~/.sat.db, we don't follow XDG base directory specifications yet), it is updated automatically if there is a schema change.
36572b0a56e6 README4PACKAGERS update
Goffi <goffi@goffi.org>
parents: 872
diff changeset
107
36572b0a56e6 README4PACKAGERS update
Goffi <goffi@goffi.org>
parents: 872
diff changeset
108
36572b0a56e6 README4PACKAGERS update
Goffi <goffi@goffi.org>
parents: 872
diff changeset
109 ##############
36572b0a56e6 README4PACKAGERS update
Goffi <goffi@goffi.org>
parents: 872
diff changeset
110 CONTRAT SOCIAL
36572b0a56e6 README4PACKAGERS update
Goffi <goffi@goffi.org>
parents: 872
diff changeset
111 ##############
36572b0a56e6 README4PACKAGERS update
Goffi <goffi@goffi.org>
parents: 872
diff changeset
112
36572b0a56e6 README4PACKAGERS update
Goffi <goffi@goffi.org>
parents: 872
diff changeset
113 The social contract is an important part of the project, please don't forget to distribute it with SàT
36572b0a56e6 README4PACKAGERS update
Goffi <goffi@goffi.org>
parents: 872
diff changeset
114
36572b0a56e6 README4PACKAGERS update
Goffi <goffi@goffi.org>
parents: 872
diff changeset
115
36572b0a56e6 README4PACKAGERS update
Goffi <goffi@goffi.org>
parents: 872
diff changeset
116 ####
36572b0a56e6 README4PACKAGERS update
Goffi <goffi@goffi.org>
parents: 872
diff changeset
117 MISC
36572b0a56e6 README4PACKAGERS update
Goffi <goffi@goffi.org>
parents: 872
diff changeset
118 ####
36572b0a56e6 README4PACKAGERS update
Goffi <goffi@goffi.org>
parents: 872
diff changeset
119
36572b0a56e6 README4PACKAGERS update
Goffi <goffi@goffi.org>
parents: 872
diff changeset
120 There is a completion file for Zsh which detect the parameters of jp. It's available in misc/ directory (.jp) and must be available in a path included in user's fpath.
36572b0a56e6 README4PACKAGERS update
Goffi <goffi@goffi.org>
parents: 872
diff changeset
121 The translation are global to all the frontend (no translation available in Libervia yet). There are not up-to-date for 0.4 version.
36572b0a56e6 README4PACKAGERS update
Goffi <goffi@goffi.org>
parents: 872
diff changeset
122
36572b0a56e6 README4PACKAGERS update
Goffi <goffi@goffi.org>
parents: 872
diff changeset
123
36572b0a56e6 README4PACKAGERS update
Goffi <goffi@goffi.org>
parents: 872
diff changeset
124
36572b0a56e6 README4PACKAGERS update
Goffi <goffi@goffi.org>
parents: 872
diff changeset
125
36572b0a56e6 README4PACKAGERS update
Goffi <goffi@goffi.org>
parents: 872
diff changeset
126 Thank you again for you help, don't forget to give us your name and contact email so we can credit you, and don't hesitate to contact us if you have any question (on the sat XMPP room at sat@chat.jabberfr.org, or check README for individual contacts).
36572b0a56e6 README4PACKAGERS update
Goffi <goffi@goffi.org>
parents: 872
diff changeset
127