source: lliurex-mate-welcome/trunk/fuentes/README.md @ 4060

Last change on this file since 4060 was 4060, checked in by alviboi, 3 years ago
File size: 5.7 KB
Line 
1# lliurex-mate-welcome
2
3The LliureX MATE Welcome application to greet both new and returning users on their first login.
4
5## Features
6
7  * **Introduce new users to the operating system.**
8    * Highlight key features of LliureX 16.
9    * Provide quick guidelines on getting started.
10    * Provide quick installation guidance.
11    * Inform users of their own system specifications.
12  * **Grow the LliureX 16 community**
13    * Accessible links to the community forums and social networks.
14    * Inform of Ubuntu MATE branded products for sale.
15    * Provide details on donating to the project.
16  * **Install Software**
17    * From a pick of Ubuntu MATE's recommended software tested for the distribution.
18    * Install a package manager, such as *Ubuntu Software Center*.
19
20Originally based on:
21
22  * https://github.com/Antergos/antergos-welcome
23  * http://blog.schlomo.schapiro.org/2014/01/apt-install.html
24
25## Testing Arguments
26
27Welcome does not require arguments for general usage, but for debugging
28and testing purposes, the following can be specified:
29
30#### ubuntu-mate-welcome
31
32  * `-v` `--verbose` = Show more details to stdout.
33  * `--force-arch=<ARCH>` = Simulate an architecture.
34    * `i386` or `amd64` or `armvf` or `powerpc`
35  * `--force-session=<TYPE>` = Simulate a specific type of session where Welcome is accessed.
36    * `live` (Live Session) or `guest` (Guest User) or `pi` (Raspberry Pi 2) or `vbox` (VirtualBox)
37  * `--force-codename=<NAME>` = Simulate a specific Ubuntu release. For testing Software Boutique.
38    * Eg. `trusty` or `wily` or `xenial`.
39  * `--force-no-net` = Simulate no internet connection.
40  * `--force-net` = Simulate an internet connection.
41  * `--locale` = specify a locale to use, otherwise the default locale will be used.
42    * If testing translations, run `./edgar-allan translate-all` first.
43  * `--software-only` = Software Boutique mode. (Hides social links, uses a larger window)
44  * `--simulate-changes` = Simulate changes made to packages without modifying the system.
45  * `--jump-to=<PAGE>` = Jump to a specific page, excluding the `.html` extension.
46  * `--font-dpi=<NUMBER>` = Override the font size by specifying a font DPI.
47
48
49#### tools/app-index-debugger.py
50
51  * `--validate`  =  Check index for consistent data types and required values.
52  * `--list-index`  =  List applications in the index.
53  * `--list-broken`  =  List applications that are not working.
54  * `--list-missing-codename=<RELEASE>`  =  List applications not present in a release.
55  * `--list-missing-arch=<ARCH>`  =  List applications not present for an architecture.
56  * `--list-special`  =  List applications that pre-install differently on releases.
57  * `--list-sources`  =  List each application\'s source (eg. PPA, Ubuntu Archives)
58
59
60## Requirements
61
62  * gir1.2-gtk-3.0
63  * gir1.2-notify-0.7
64  * gir1.2-webkit-3.0
65  * libgtk2-perl
66  * libnotify-bin
67  * parted
68  * pciutils
69  * policykit-1
70  * python3
71  * python3-apt
72  * python3-aptdaemon
73  * python3-aptdaemon.gtk3widgets
74  * python3-gi
75  * software-properties-common
76  * inxi
77  * humanity-icon-theme
78
79## Preview in another locale.
80
81Navigate to your repository folder.
82
83    ./edgar-allan translate-all
84    ./lliurex-mate-welcome --locale=<CODE>
85
86Use the verbose flag (`-v`) for more detailed output on which
87pages will use the translated version.
88
89Currently, Welcome still uses English for:
90
91  * Software Boutique - Names and descriptions for applications.
92  * Terminal debug output.
93  * Screenshots.
94
95
96## edgar-allan
97
98Stupid name, but we like it, which supports the following arguments:
99
100  * `create-all-pots` - will create a `.pot` file for every slide (using
101  `@zwnj;` chars to denote translatable string) and place it in `data/po/<slide name>`
102  * `translate-all` - for each slide, will produce translated html for
103  each `.po` found in `data/po/slidename`. The `.po` should according to
104  locale e.g. `en_GB.po`. The output will be written to the
105  `i18n/<locale>/` directory as `slide_name.html`
106  * `create-pot` - create a single `.pot` file (mainly for testing purposes)
107  * `translate` - translate a single slide (mainly for testing purposes)
108  * `po` - for each translatable string in a po file, set the
109  translation to be the original string reversed (only for use when
110  testing...)
111
112Addtional arguments:
113
114  * `--input=<filename>` used with `create-pot` and translate and
115  specifies the source html. Also used with `po` to specified `.po` file
116  containing strings to be reversed `--po-file=<filename>` used with
117  `translate` and specified `.po` file to use
118  * `--output=<filename>` used with `create-pot`, `translate` and `po`
119  and specifies the output file
120
121Normal usage would be to:
122
123  * run `create-pot` to create an initial set of `.pot` files or to
124  update them when new strings are added to slides.
125  * check the .pots in `poedit` or a text editor in case missing or
126  misaligned `&zwnj;`'s in the html
127  * copy `.po` files translations from Transiflex into the
128  `data/po/<slide_name>/` directories
129  * run `translate-all` to build a set of translated slides
130
131## create-test-pos.sh
132
133For testing purposes only. After `edgar-allan create-all-pots` has been
134run, this can be used to generate test `en_GB` and `fr_FR` .po files for
135each slide. The `en_GB` version contains no translations whilst the
136French version has every translation set as the reverse of the original
137string. Translated html can be produced from these .po files by running
138`edgar-allan translate-all`, and viewed in the `i18n/en_GB` and `fr_FR`
139directories.
140
141# Building a local package
142
143If you want to build a local package for testing then do the following:
144
145    sudo apt-get install python3-polib
146    ./welcome-po.py --update-pos
147    ./welcome-po.py --install
148    ./edgar-allan translate-all
149    debuild -b
150
151The resulting `.deb` can be installed with `sudo dpkg -i` or `gdebi`.
Note: See TracBrowser for help on using the repository browser.