comparison README4PACKAGERS @ 873:36572b0a56e6

README4PACKAGERS update
author Goffi <goffi@goffi.org>
date Wed, 26 Feb 2014 01:54:16 +0100
parents a650f01737d7
children 3a943b5f2cec
comparison
equal deleted inserted replaced
872:a650f01737d7 873:36572b0a56e6
1 First of all, thank you for packaging SàT :) 1 First of all, thank you for packaging SàT :)
2 2
3 You will find below the list of dependencies for the backend and the frontends. 3 You will find below the list of dependencies for the backend and the frontends, and some other infos.
4 4
5 ############################ 5 ############################
6 List of general dependencies 6 List of general dependencies
7 ############################ 7 ############################
8 8
52 ##################################### 52 #####################################
53 53
54 wxPython 54 wxPython
55 55
56 56
57 Thank you again for you help, don't forget to give me your name and contact email so I can credit you, and don't hesitate to contact me if you have any question (goffi@goffi.org, or the sat XMPP room at sat@chat.jabberfr.org). 57 ##################
58 Satellite projects
59 ##################
58 60
61 Several project have been made around SàT, they are all available at http://repos.goffi.org:
62
63 - Libervia: the both Ajax and static web frontend
64
65 - SàT PubSub: a PubSub service which manage experimental features like fine permission tuning
66
67 - SàT media: Media needed to by the frontends
68
69 - Urwid SàText: Widgets for urwid library, designed for SàT but can be useful for other projects. Mandatory for Primitivus
70
71 ## Folowing ones are not needed in a distribution, because there are in a too early stage of development, or not useful for general purpose ##
72
73 - Bellaciao: a Qt frontend, at an early stage of development
74
75 - Salut: a XMPP directory, at a very early stage of development
76
77 - SàT Website: the code of the website
78
79
80 ########
81 Licences
82 ########
83
84 We are careful about the licences we use. Our projects are licenced as follow:
85
86 - Libervia, SàT PubSub, Bellaciao, Salut, SàT Website: AGPL v3+
87
88 - Urwid SàText: LGPL v3+
89
90 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.
91
92 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.
93
94
95 #####################
96 Packages and versions
97 #####################
98
99 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.
100
101 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.
102
103 All the official frontends have the same version, which is the version of the backend they use.
104
105
106 #######
107 Updates
108 #######
109
110 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.
111
112
113 ##############
114 CONTRAT SOCIAL
115 ##############
116
117 The social contract is an important part of the project, please don't forget to distribute it with SàT
118
119
120 ####
121 MISC
122 ####
123
124 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.
125 The translation are global to all the frontend (no translation available in Libervia yet). There are not up-to-date for 0.4 version.
126
127
128
129
130 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).
131