Difference between revisions of "Developer's corner"

From GCompris
Jump to: navigation, search
(Mailing list)
 
(78 intermediate revisions by 9 users not shown)
Line 1: Line 1:
== Branches ==
+
{{TOCright}}
 +
= Contact =
  
We use [http://git-scm.com/ git] for our development. The [http://git.gnome.org/browse/gcompris/ git repository] is hosted by Gnome but we also have a [http://gcompris.net/gitweb local web viewer].
+
This page is about the '''Qt version'''. Follow there for the [[Developer's corner Gtk|Gtk+ legacy version]].
  
To get the GCompris master branch (warning this takes more than 500MB) :
+
== How to report a bug ==
<code><pre>
 
git clone git://git.gnome.org/gcompris
 
cd gcompris
 
sh autogen.sh && make
 
</pre></code>
 
  
Alternatively, if you are only interested in the recent history, and would want to send in fixes as patches, you can use the option: <code>git clone --depth=1 git://git.gnome.org/gcompris</code>. It will save you more than 100MB.
+
To fill a bug report for GCompris:
  
== Dependencies ==
+
* Legacy Gtk+ Version: [http://bugzilla.gnome.org/query.cgi gnome bugzilla] and select GCompris in the product list.
 +
* New Qt Quick version: [https://bugs.kde.org KDE bug tracker] and select GCompris in the product list or for [https://phabricator.kde.org/maniphest/query/0Xc51jhWJnw0/#R internal development we use Phabricator]
  
GCompris has a lot of dependencies. On a Debian based distribution that already packages GCompris, you can install all the required dependencies with the command 'apt-get build-dep gcompris'.
+
== Mailing list ==
  
== Documentation ==
+
You can join and browse the [https://mail.kde.org/mailman/listinfo/gcompris-devel GCompris mailing list].
* [[GCompris internals]] gives an overview of the design of GCompris. It is a good starting point for anybody willing to contribute code.
 
* [[Adding an activity]]
 
* [[Adding a puzzle activity]]
 
  
== The Drawing board ==
+
This mailing list is used by the developers and users willing to stay aware of what’s going on. You will get new release announcements. Users can join the list and report bugs, discuss feature they would like to have, ...
 +
 
 +
The language is English. There is also a user mailing list in [https://mail.kde.org/mailman/listinfo/gcompris-france French] and in [https://lists.sourceforge.net/lists/listinfo/gcompris-portugues Portuguese].
 +
 
 +
== Chat ==
 +
 
 +
You can enter in contact with the users and developers of [http://en.wikipedia.org/wiki/IRC GCompris on IRC]. The server is irc.freenode.net on the channel #gcompris.
 +
 
 +
To join an IRC server, you can use the [https://hexchat.github.io excellent hexchat software] or [http://webchat.freenode.net/ directly in your browser].
 +
 
 +
= Development =
 +
 
 +
== Documentation of the Qt Quick Version (Under development) ==
 +
 
 +
This is a new version of GCompris based on the [http://doc.qt.io/qt-5/qtquick-index.html Qt Quick] technology. Our users expect us to deliver a version that runs on Desktop and on Tablets. Sadly with the Gtk+ version these was no easy way to achieve this. The decision has been taken to rewrite completely GCompris on a new framework. This is a departure from the Gtk+ development framework that was based on the C and the Python language. Now the development will be done with a mix of QML, JavaScript and C++.
 +
 
 +
The rewrite will not happen overnight and we need your help. If you are interesting in discovering the Qt Quick technology while doing something useful, you can do the port of a GCompris activity.
 +
 
 +
* Qt Quick [https://invent.kde.org/education/gcompris official repository] or [https://github.com/gcompris/GCompris-qt GitHub mirror]
 +
* [[Qt Quick development process]]
 +
* [[Qt Quick Migration status]]
 +
* [[Contribution process]]
 +
* [[New contributor]]
 +
 
 +
=== Design ===
  
These are pages to hold the different discussion for thinks we are working on:
+
* [[Administration design]]
 +
* [[Dataset handling]]
 +
* [[Artwork guidelines]]
  
* [[Ideas for activities]]
+
=== Translation ===
* [[Star system review]]
 
* [[Todo for OLPC]]/sugar future ? Review of sugar/OLPC activities and way to integrate.
 
* [[Notes on OSX port]]
 
* [[Tuxdroid]] is a little robot from Kysoh that would be fun to integrate with GCompris.
 
* [[Icons Sugarisation]]
 
* [[Language Learning]]
 
  
== Translations ==
+
Translations are managed by the [http://l10n.kde.org/ KDE translation teams]. If you would like to participate in the translation of GCompris you must contact the KDE translation team you want to participate in.
  
* GCompris translations are managed by the [http://l10n.gnome.org/teams/ Gnome translation teams].
+
* [http://l10n.kde.org/stats/gui/stable-kf5/po/gcompris_qt.po/ Translation status for the stable version]
* [http://l10n.gnome.org/module/gcompris/#master Translation status] for the Software itself.
+
* [http://l10n.kde.org/stats/gui/trunk-kf5/po/gcompris_qt.po/ Translation status for the development version]
* [[Translation addons]]. There is more than the .po file to translation GCompris.
+
* [http://websvn.kde.org/trunk/l10n-kf5/ To get the po file to translate], navigate in the subversion from the previous link, select your locale then go to the subdirectory messages/extragear-edu/. If you encounter a 404 page error, it means the translation in your locale hasn't been started yet. You can use the template in [https://websvn.kde.org/trunk/l10n-kf5/templates/messages/extragear-edu/gcompris_qt.pot?view=markup template] and contact [https://l10n.kde.org/teams-list.php your team] to have the file added for your language. If the team is no more active (no reply after 1 week), directly ping the [mailto:kde-i18n-doc@kde.org main translation mailing list] or the [mailto:gcompris-devel@kde.org GCompris development team].
* [[Voices translation]].
+
* [http://gcompris.net/voicestats Voice recording status] for each locale.
 +
* [[Word Lists Qt|Additional localized list of words]]
 +
* [[Advanced color translation]]
 +
* [[Voice translation Qt|Voice translation]]
 
* [[Web site translation]] is managed by volunteers.
 
* [[Web site translation]] is managed by volunteers.
* [[Wiktionary to XML]]
 
  
== Packagers ==
+
== The Drawing board ==
  
GCompris is a large software which has numerous dependencies. We ask packagers to be very careful and follow this minimal and [[manual test]] process.
+
These are pages to hold the different discussion for things we are working on:
+
 
 +
* [[Ideas for activities]]
 +
* [[Star system review]]
 +
* [[Language Learning]]
  
 
[[Category:Developer]]
 
[[Category:Developer]]
 +
[[Category:English]]

Latest revision as of 22:16, 10 July 2020

Contact

This page is about the Qt version. Follow there for the Gtk+ legacy version.

How to report a bug

To fill a bug report for GCompris:

Mailing list

You can join and browse the GCompris mailing list.

This mailing list is used by the developers and users willing to stay aware of what’s going on. You will get new release announcements. Users can join the list and report bugs, discuss feature they would like to have, ...

The language is English. There is also a user mailing list in French and in Portuguese.

Chat

You can enter in contact with the users and developers of GCompris on IRC. The server is irc.freenode.net on the channel #gcompris.

To join an IRC server, you can use the excellent hexchat software or directly in your browser.

Development

Documentation of the Qt Quick Version (Under development)

This is a new version of GCompris based on the Qt Quick technology. Our users expect us to deliver a version that runs on Desktop and on Tablets. Sadly with the Gtk+ version these was no easy way to achieve this. The decision has been taken to rewrite completely GCompris on a new framework. This is a departure from the Gtk+ development framework that was based on the C and the Python language. Now the development will be done with a mix of QML, JavaScript and C++.

The rewrite will not happen overnight and we need your help. If you are interesting in discovering the Qt Quick technology while doing something useful, you can do the port of a GCompris activity.

Design

Translation

Translations are managed by the KDE translation teams. If you would like to participate in the translation of GCompris you must contact the KDE translation team you want to participate in.

The Drawing board

These are pages to hold the different discussion for things we are working on: