Difference between revisions of "Developer's corner"

From GCompris
Jump to: navigation, search
(Branches)
(Translation)
 
(100 intermediate revisions by 9 users not shown)
Line 1: Line 1:
== Branches ==
+
{{TOCright}}
 +
= Contact =
  
We use [http://git-scm.com/ git] for our development. Currently, the active branches are:
+
This page is about the '''Qt version'''. Follow there for the [[Developer's corner Gtk|Gtk+ legacy version]].
  
* 8.4.X (git master): The stable version. Maintenance mode.
+
== How to report a bug ==
* 8.3.4 (git branches/GCOMPRIS_8_3): The stable version for Windows. This version exist only because I have not yet updated my build environment on Windows to support the gstreamer audio backend. Until I can build the 8.4 on Windows, I backport the main fixes and features from 8.4 in this branch.
 
* 8.XO (git origin/gcomprixo): This is the current OLPC XO branch. It's a major refactoring to allow us to provide independent activities to the OLPC project, and others.
 
* 8.5 (git origin/gcomprixogoo): This is based on the OLPC XO branch but uses the [http://live.gnome.org/GooCanvas goocanvas] instead of the gnomecanvas+libart. This is where the new code is going.
 
  
To get GCompris from git:
+
To fill a bug report for GCompris:
<code><pre>
 
git clone git://git.gnome.org/gcompris
 
cd gcompris
 
sh autogen.sh && make
 
</pre></code>
 
  
To get GCompris development branch from subversion:
+
* Legacy Gtk+ Version: [http://bugzilla.gnome.org/query.cgi gnome bugzilla] and select GCompris in the product list.
<code><pre>
+
* 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]
git clone git://git.gnome.org/gcompris
 
cd gcompris
 
git checkout -b gcomprixogoo origin/gcomprixogoo
 
</pre></code>
 
  
== Documentation ==
+
== 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 ==
+
You can join and browse the [https://mail.kde.org/mailman/listinfo/gcompris-devel 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 [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.libera.chat on the channel #gcompris.
 +
 
 +
To join an IRC server, you can use any IRC client like for example the [https://hexchat.github.io excellent hexchat software] or [https://kiwiirc.com/nextclient/ 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]]
 
* [[Requested Features]]
 
* [[GCompris work in progress]]
 
* [[Todo for 8.3]] (GCOMPRIS_8_3 branch)
 
* [[Todo for 8.4]] (trunk)
 
* [[Todo for 8.5]] (gcomprixogoo branch)
 
* [[Todo for OLPC]]/sugar future ? Review of sugar/OLPC activities and way to integrate.
 
* [[Notes on OSX port]]
 
* [[Tuxdroid]] is a little robot from [http://www.kysoh.com/ Kysoh] that would be fun to integrate with GCompris.
 
* [[Icons Sugarisation]]
 
  
== Translations ==
+
Translation guidance can be found in the [[How_to_translate|How to guide]].
  
* GCompris translations are managed by the [http://l10n.gnome.org/teams/ Gnome translation teams].
+
== The Drawing board ==
* [[Voices translation]].
 
* [[Web site translation]] is managed by volunteers.
 
  
== Packagers ==
+
These are pages to hold the different discussion for things we are working on:
  
GCompris is a large software which has numerous dependencies. We ask packagers to be very careful and follow this minimal and [[manual test]] process.
+
* [[Ideas for activities]]
+
* [[Star system review]]
 +
* [[Language Learning]]
  
 
[[Category:Developer]]
 
[[Category:Developer]]
 +
[[Category:English]]

Latest revision as of 16:33, 12 December 2021

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.libera.chat on the channel #gcompris.

To join an IRC server, you can use any IRC client like for example 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

Translation guidance can be found in the How to guide.

The Drawing board

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