Mercurial > libervia-backend

comparison README4PACKAGERS @ 899:7565d3ac0a96

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
misc: README4PACKAGERS improvments
author Matteo Cypriani <mcy@lm7.fr>
date Wed, 05 Mar 2014 16:03:05 +0100
parents 0199a17f4d92
children 1e0550271546
comparison
equal deleted inserted replaced
898:9720d3d0a764 899:7565d3ac0a96
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, and some other infos.
4 3
5 ############################ 4 ############
6 List of general dependencies 5 Dependencies
7 ############################ 6 ############
8 7
9 Python 2.7 8 SàT requires Python 2.7.
10 dbus-python 9 You will find below the list of Python modules the backend and the frontends depend on, as well as additional information.
11 10
12 #################################### 11 ------------------------------
13 List of dependencies for SàT backend 12 Dependencies for SàT's backend
14 #################################### 13 ------------------------------
15 14
15 dbus
16 lxml 16 lxml
17 Mutagen 17 Mutagen
18 PIL 18 PIL
19 PyFeed 19 PyFeed
20 Twisted Core 20 Twisted Core
23 Twisted Words 23 Twisted Words
24 Wokkel 24 Wokkel
25 xe 25 xe
26 zope.interface 26 zope.interface
27 27
28 Recommandation: markdown, html2text 28 Recommended: markdown, html2text
29 29
30 #################################### 30 --------------------------------
31 List of dependencies for Jp frontend 31 Dependencies for the Jp frontend
32 #################################### 32 --------------------------------
33 33
34 GObject 34 PyGI (PyGObject 3)
35 Recommandation: progressbar
36 35
37 ############################################ 36 Recommended: progressbar
38 List of dependencies for Primitivus frontend
39 ############################################
40 37
38 ----------------------------------------
39 Dependencies for the Primitivus frontend
40 ----------------------------------------
41
42 dbus
41 Urwid 43 Urwid
42 Urwid-satext 44 Urwid-satext
43 GObject (not imported directly in Primitivus, but needed for Urwid's main loop) 45 GObject (not imported directly in Primitivus, but needed for Urwid's main loop)
44 46
45 Suggestion: Python X Library 47 Suggested: Python X Library (for user notifications in a graphical session)
46 48
47 ##################################### 49 ---------------------------------
48 List of dependencies for Wix frontend 50 Dependencies for the Wix frontend
49 ##################################### 51 ---------------------------------
50 52
51 wxPython 53 wxPython
52 54
53 55
54 ################## 56 ##################
55 Satellite projects 57 Satellite projects
56 ################## 58 ##################
57 59
58 Several project have been made around SàT, they are all available at http://repos.goffi.org: 60 Several project have been made around SàT, they are all available at http://repos.goffi.org:
59 61
60 - Libervia: the both Ajax and static web frontend 62 - Libervia: the both Ajax and static web frontend.
61 63
62 - SàT PubSub: a PubSub service which manage experimental features like fine permission tuning 64 - SàT PubSub: a PubSub service which manage experimental features like fine permission tuning.
63 65
64 - SàT media: Media needed to by the frontends 66 - SàT media: Media needed to by the frontends.
65 67
66 - Urwid SàText: Widgets for urwid library, designed for SàT but can be useful for other projects. Mandatory for Primitivus 68 - Urwid SàText: Widgets for urwid library, designed for SàT but can be useful for other projects. Mandatory for Primitivus.
67 69
68 ## Folowing ones are not needed in a distribution, because there are in a too early stage of development, or not useful for general purpose ## 70 The following ones are not needed in a distribution, because there are in too early a stage of development, or not useful for general purpose:
69 71
70 - Bellaciao: a Qt frontend, at an early stage of development 72 - Bellaciao: a Qt frontend, at an early stage of development.
71 73
72 - Salut: a XMPP directory, at a very early stage of development 74 - Salut: an XMPP directory, at a very early stage of development.
73 75
74 - SàT Website: the code of the website 76 - SàT Website: the code of the website.
75 77
76 78
77 ######## 79 ########
78 Licences 80 Licences
79 ######## 81 ########
82 84
83 - Libervia, SàT PubSub, Bellaciao, Salut, SàT Website: AGPL v3+ 85 - Libervia, SàT PubSub, Bellaciao, Salut, SàT Website: AGPL v3+
84 86
85 - Urwid SàText: LGPL v3+ 87 - Urwid SàText: LGPL v3+
86 88
87 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. 89 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 made a mistake somewhere, please let us know.
88 90
89 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. 91 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.
90 92
91 93
92 ##################### 94 #####################
93 Packages and versions 95 Packages and versions
94 ##################### 96 #####################
95 97
96 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. 98 We have packaged Wix, Primitivus, and Jp with the core backend, as we think theses frontends should be shipped with each SàT distribution. But allowing them to be installed separately would be good: for example, Wix will be useless for a server or non-graphical workstation.
97 99
98 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. 100 Libervia is distributed as a separate package because of its specificities (it's a huge project by itself, it uses Pyjamas Python => JS Compiler, etc.). But it's part of the same project.
99 101
100 All the official frontends have the same version, which is the version of the backend they use. 102 All the official frontends have the same version number, which is the version of the backend they use.
101 103
102 104
103 ####### 105 #######
104 Updates 106 Updates
105 ####### 107 #######
106 108
107 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. 109 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.
108 110
109 111
110 ############## 112 ##############
111 CONTRAT SOCIAL 113 Contrat social
112 ############## 114 ##############
113 115
114 The social contract is an important part of the project, please don't forget to distribute it with SàT 116 The social contract is an important part of the project, please don't forget to distribute it along with SàT.
115 117
116 118
117 #### 119 #############
118 MISC 120 Miscellaneous
119 #### 121 #############
120 122
121 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. 123 There is a completion file for Zsh which detects the parameters of Jp. It's available in the misc/ directory (.jp) and must be available in a path included in user's fpath.
122 The translation are global to all the frontend (no translation available in Libervia yet). There are not up-to-date for 0.4 version. 124 The translations are global to all the frontends (no translations available in Libervia yet). There are not up-to-date for 0.4 version.
123 125
124 126
125 127 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).
126
127 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).
128