Editing Miniature/Development

Warning: You are not logged in. Your IP address will be recorded in this page's edit history.

The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then save the changes below to finish undoing the edit.

Learn more about Contributing to the wiki.

== The concept == 
[[Miniature]] is a chess board that is always with you, ready to let you play and learn wherever you go.

* The main use case is playing online against other players at http://www.freechess.org/ (FICS)
* Now imagine that you can also chat with the other player.
* Play P2P games against other players next to you or remotely with your Contacts.
* Learning is important: watch games live, review stored games and also process offline the lessons offered at FICS.
* And not only regular chess. Think also on Suicide, Crazyhouse...

Miniature is a Qt application with a C/C++ backend and a QML UI. The architecture is modular, thinking on the addition of different servers and types of interaction.

We are targeting our development on MeeGo Harmattan and the Nokia N9 but we welcome maintainers for other ports e.g. MeeGo upstream, Symbian, Android-Necessitas, Qt powered desktops...

== Project news ==
* 2011-09-13: [http://wiki.maemo.org/QtComponents/Miniature Miniature bootlegged for Fremantle].
* 2011-08-29: [https://bugs.maemo.org/show_bug.cgi?id=12355 first patch] from Uwe Kaminski aka jukey committed to the Miniature project. Thank you!
* 2011-08-28: "New seek" feature implemented, mikhas and jukey play the first Miniature vs Miniature game from their devices. 
* 2011-08-26: First real & unstable [https://bugs.maemo.org/show_bug.cgi?id=12342#c2 FICS games played]. First it was mikhas against himhelf, then mikhas-qgil.  :)
* 2011-08-25: [http://flors.wordpress.com/2011/08/25/how-quick-i-got-started-with-qt-quick/ How quick I got started with Qt Quick] - blog post from Quim Gil featuring Miniature.
* 2011-08-25: Miniature 0.3 [https://garage.maemo.org/pipermail/chess-developer/2011-August/000185.html runs in MeeGo 1.2 CE] on a Nokia N900 (with some bugs).
* '''2011-08-23: [http://wiki.maemo.org/Miniature/0.3_Berlin_Defence Miniature 0.3 ''Berlin Defence''] released.'''
* 2011-08-15: New Miniature UX concepts integrated to the master branch - the new engine gets a UI ([http://wiki.maemo.org/images/2/25/2011-08-12_16-25-47.png screenshot]).
* 2011-08-13: Miniature can be developed using Qt Creator ([https://gitorious.org/miniature/miniature/blobs/raw/master/README.qt-sdk instructions]).
* 2011-08-01: [https://garage.maemo.org/pipermail/chess-developer/2011-August/000159.html Miniature 0.2.1 released!] The new Encore engine and the new QML UI, together for the first time. The game can do real seeks but still no real games.
* 2011-07-27: New UI targetting MeeGo Harmattan developed in parallel - [https://gitorious.org/testdef source] & [https://bugs.maemo.org/show_bug.cgi?id=12315 packages] for Nokia N9/N950.
* 2011-07-18: engine refactored around [https://garage.maemo.org/pipermail/chess-developer/2011-July/000153.html Encore], a GNUChess wrapper. This is the beginning of a rewrite.
* 2011-07-06: request to port to [[Meego]] : http://forum.meego.com/showthread.php?p=25031

The Miniature project was born as a proposal sent to the Maemo community on 2009-10-31. Check the [[Miniature/archive|archive]] if you want to dig in the past.

== Project status ==

Tasks for the next release get a HIGH priority. All the rest falls in the Backlog.

=== Miniature 0.5 release ===

Tasks COMMITTED for Miniature 0.5.

{{#bugzilla:id=7867,12345,12351,12359,12390,12394,12419,12420,12426,12435,12455,12456,12464
  |columns=id,severity,status,resolution,summary
  |sort=resolution,status,severity,id
}}

=== Backlog ===

{{#bugzilla:
  |columns=id,severity,priority,assignee,status,resolution,summary
  |product=Miniature
  |priority=Medium,Low,Unspecified
  |status=unconfirmed,new,assigned,needinfo,reopened
  |sort=status,id
}}

=== Easyfix (suited for newcomers) ===

{{#bugzilla:
  |columns=id,severity,priority,assignee,status,resolution,summary
  |product=Miniature
  |keywords=easyfix
  |status=unconfirmed,new,assigned,reopened
  |sort=priority,severity,priority,status,id
}}

Looking for more? There is more at the [[Miniature/Wishlist|Wishlist]].

== Get involved ==
Contributions are welcome! This is how you can get started:

* [[Miniature#Download|Download]] or [[#SDK instructions|build]] Miniature, and [[Miniature#Contact us|tell us]] what you think
* Spread the Miniature love among your Chess friendly contacts
* Test the game and [https://bugs.maemo.org/buglist.cgi?query_format=specific&order=relevance+desc&bug_status=__open__&product=Miniature&content= check/file bugs]
**Follow all of the project's bug by entering <code>general@miniature.garage.bugs</code> into the ''Add users to my watch list (comma separated list)'' input field 
**Table of [[/testcases|testcases]]
* Fix an open bug in the [[Miniature/Development#Backlog|Backlog]], for instance an [https://bugs.maemo.org/buglist.cgi?keywords=easyfix&query_format=advanced&keywords_type=allwords&bug_status=UNCONFIRMED&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&product=Miniature&classification=Extras easyfix].
* Help planning and implementing [[Miniature/Wishlist|new features]]
* Help porting Miniature to more platforms

=== Localization ===
The localization work hasn't started yet and as a matter of fact our strings are still not L10n ready. It's in our ToDo list, do you want to help?

=== SDK instructions ===
Currently you can build Miniature with the latest Qt SDK (including the Harmattan target) or the Harmattan Platform SDK. The Miniature sources and commit logs are available at https://gitorious.org/miniature/ . Both SDKs come with an emulator for deploying your app. All the better if you have a Nokia N950 or N9 to test on device.

Instructions to set you Miniature development environment:
* [https://gitorious.org/miniature/miniature/blobs/raw/master/README.qt-sdk Qt SDK]
* Harmattan Platform SDK instructions are currently missing. fwiw the [[Miniature/Development/Instructions|Maemo Platform SDK]] might help since both are based on Scratchbox...
=== Set up a personal clone repository of Minature ===
If you plan to get involved deeper into development it's a good idea to create a personal clone of the Minature git source repository. This allows you to do merge requests for patches you created in your clone repository. The cloned repository should be connected to Minature as upstream to make it easy to fetch changes from there. Step-by-step description:
*Create an gitorious account or log in and make sure to have an SSH-Key in place 
*[https://gitorious.org/miniature/miniature/clone Clone repository]
*To allow pushing to your clone repository Follow the instructions you will get if you click onto the little green question mark next to the clone URL.
*enable upstream: Open a terminal and switch into the local folder of your clone project and enter:
 git remote add upstream git://gitorious.org/miniature/miniature.git
*fetch upstream data:
 git fetch upstream master
*Create merge requests: You can use the "Request merge" button in your gitorious clone project website.

=== Send us patches! ===
Found a bug? Spotted code smell? We glady accept patches! There are three ways to send patches to us:
* By [https://bugs.maemo.org/buglist.cgi?product=Miniature reporting the bug], and hopefully attaching a patch that solves the stated problem (but just reporting bugs is also appreciated).
* By using the [https://garage.maemo.org/mailman/listinfo/chess-developer chess-devel mailing list]: A ML-friendly patch can be created with "git format-patch HEAD~n", where n specifices how many commits (starting from HEAD) should be converted to patches;
* By issuing a merge request: Send us a link to your public git repo (including branch/revision), or use the merge request feature from http://gitorious.org.

=== Architecture ===
See the [[Miniature/Development/Architecture|Miniature architecture]] wiki page. (outdated)

== Contributors ==
Maintainers:
* [http://maemo.org/profile/view/mikhas Michael Hasselmann]: lead developer
* [http://maemo.org/profile/view/qgil Quim Gil]: UX & documentation

Gave a big hand:
* [http://maemo.org/profile/view/kore Dennis Stötzel]: chess logics
* [http://maemo.org/profile/view/hasselmm Mathias Hasselmann]: veteran programmer
* [http://gitorious.org/~Malcolm Dariusz Mikulski]: P2P telepathy integration

Special thanks:
* [http://maemo.org/profile/view/kittykat kittykat]: game icon
* [http://en.wikipedia.org/wiki/User:Cburnett Colin M.L. Burnett]: free piece set used by Wikipedia

Please note that all contributions to maemo.org wiki may be edited, altered, or removed by other contributors. If you do not want your writing to be edited mercilessly, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource (see maemo.org wiki:Copyrights for details). Do not submit copyrighted work without permission!

Summary:

Cancel | Editing help (opens in new window)

Templates used on this page:

Template:Miniature (edit)

Retrieved from "https://wiki.maemo.org/Miniature/Development"

Personal tools

Navigation

Views

Editing Miniature/Development

@@ Line 1: / Line 1: @@
 {{Miniature}}
- Most content of this page has moved to http://miniature-chess.org/
+== The concept ==
- We are waiting to get the BugzillaReports extension running to move the rest.
+[[Miniature]] is a chess board that is always with you, ready to let you play and learn wherever you go.
+* The main use case is playing online against other players at http://www.freechess.org/ (FICS)
+* Now imagine that you can also chat with the other player.
+* Play P2P games against other players next to you or remotely with your Contacts.
+* Learning is important: watch games live, review stored games and also process offline the lessons offered at FICS.
+* And not only regular chess. Think also on Suicide, Crazyhouse...
+Miniature is a Qt application with a C/C++ backend and a QML UI. The architecture is modular, thinking on the addition of different servers and types of interaction.
+We are targeting our development on MeeGo Harmattan and the Nokia N9 but we welcome maintainers for other ports e.g. MeeGo upstream, Symbian, Android-Necessitas, Qt powered desktops...
+== Project news ==
+* 2011-09-13: [http://wiki.maemo.org/QtComponents/Miniature Miniature bootlegged for Fremantle].
+* 2011-08-29: [https://bugs.maemo.org/show_bug.cgi?id=12355 first patch] from Uwe Kaminski aka jukey committed to the Miniature project. Thank you!
+* 2011-08-28: "New seek" feature implemented, mikhas and jukey play the first Miniature vs Miniature game from their devices.
+* 2011-08-26: First real & unstable [https://bugs.maemo.org/show_bug.cgi?id=12342#c2 FICS games played]. First it was mikhas against himhelf, then mikhas-qgil.  :)
+* 2011-08-25: [http://flors.wordpress.com/2011/08/25/how-quick-i-got-started-with-qt-quick/ How quick I got started with Qt Quick] - blog post from Quim Gil featuring Miniature.
+* 2011-08-25: Miniature 0.3 [https://garage.maemo.org/pipermail/chess-developer/2011-August/000185.html runs in MeeGo 1.2 CE] on a Nokia N900 (with some bugs).
+* '''2011-08-23: [http://wiki.maemo.org/Miniature/0.3_Berlin_Defence Miniature 0.3 ''Berlin Defence''] released.'''
+* 2011-08-15: New Miniature UX concepts integrated to the master branch - the new engine gets a UI ([http://wiki.maemo.org/images/2/25/2011-08-12_16-25-47.png screenshot]).
+* 2011-08-13: Miniature can be developed using Qt Creator ([https://gitorious.org/miniature/miniature/blobs/raw/master/README.qt-sdk instructions]).
+* 2011-08-01: [https://garage.maemo.org/pipermail/chess-developer/2011-August/000159.html Miniature 0.2.1 released!] The new Encore engine and the new QML UI, together for the first time. The game can do real seeks but still no real games.
+* 2011-07-27: New UI targetting MeeGo Harmattan developed in parallel - [https://gitorious.org/testdef source] & [https://bugs.maemo.org/show_bug.cgi?id=12315 packages] for Nokia N9/N950.
+* 2011-07-18: engine refactored around [https://garage.maemo.org/pipermail/chess-developer/2011-July/000153.html Encore], a GNUChess wrapper. This is the beginning of a rewrite.
+* 2011-07-06: request to port to [[Meego]] : http://forum.meego.com/showthread.php?p=25031
+The Miniature project was born as a proposal sent to the Maemo community on 2009-10-31. Check the [[Miniature/archive|archive]] if you want to dig in the past.
 == Project status ==
@@ Line 37: / Line 64: @@
 }}
-Looking for more? There is more at the [http://miniature-chess.org/wiki/Wishlist Wishlist].
+Looking for more? There is more at the [[Miniature/Wishlist|Wishlist]].
+== Get involved ==
+Contributions are welcome! This is how you can get started:
+* [[Miniature#Download|Download]] or [[#SDK instructions|build]] Miniature, and [[Miniature#Contact us|tell us]] what you think
+* Spread the Miniature love among your Chess friendly contacts
+* Test the game and [https://bugs.maemo.org/buglist.cgi?query_format=specific&order=relevance+desc&bug_status=__open__&product=Miniature&content= check/file bugs]
+**Follow all of the project's bug by entering <code>general@miniature.garage.bugs</code> into the ''Add users to my watch list (comma separated list)'' input field
+**Table of [[/testcases|testcases]]
+* Fix an open bug in the [[Miniature/Development#Backlog|Backlog]], for instance an [https://bugs.maemo.org/buglist.cgi?keywords=easyfix&query_format=advanced&keywords_type=allwords&bug_status=UNCONFIRMED&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&product=Miniature&classification=Extras easyfix].
+* Help planning and implementing [[Miniature/Wishlist|new features]]
+* Help porting Miniature to more platforms
+=== Localization ===
+The localization work hasn't started yet and as a matter of fact our strings are still not L10n ready. It's in our ToDo list, do you want to help?
+=== SDK instructions ===
+Currently you can build Miniature with the latest Qt SDK (including the Harmattan target) or the Harmattan Platform SDK. The Miniature sources and commit logs are available at https://gitorious.org/miniature/ . Both SDKs come with an emulator for deploying your app. All the better if you have a Nokia N950 or N9 to test on device.
+Instructions to set you Miniature development environment:
+* [https://gitorious.org/miniature/miniature/blobs/raw/master/README.qt-sdk Qt SDK]
+* Harmattan Platform SDK instructions are currently missing. fwiw the [[Miniature/Development/Instructions|Maemo Platform SDK]] might help since both are based on Scratchbox...
+=== Set up a personal clone repository of Minature ===
+If you plan to get involved deeper into development it's a good idea to create a personal clone of the Minature git source repository. This allows you to do merge requests for patches you created in your clone repository. The cloned repository should be connected to Minature as upstream to make it easy to fetch changes from there. Step-by-step description:
+*Create an gitorious account or log in and make sure to have an SSH-Key in place
+*[https://gitorious.org/miniature/miniature/clone Clone repository]
+*To allow pushing to your clone repository Follow the instructions you will get if you click onto the little green question mark next to the clone URL.
+*enable upstream: Open a terminal and switch into the local folder of your clone project and enter:
+ git remote add upstream git://gitorious.org/miniature/miniature.git
+*fetch upstream data:
+ git fetch upstream master
+*Create merge requests: You can use the "Request merge" button in your gitorious clone project website.
+=== Send us patches! ===
+Found a bug? Spotted code smell? We glady accept patches! There are three ways to send patches to us:
+* By [https://bugs.maemo.org/buglist.cgi?product=Miniature reporting the bug], and hopefully attaching a patch that solves the stated problem (but just reporting bugs is also appreciated).
+* By using the [https://garage.maemo.org/mailman/listinfo/chess-developer chess-devel mailing list]: A ML-friendly patch can be created with "git format-patch HEAD~n", where n specifices how many commits (starting from HEAD) should be converted to patches;
+* By issuing a merge request: Send us a link to your public git repo (including branch/revision), or use the merge request feature from http://gitorious.org.
+=== Architecture ===
+See the [[Miniature/Development/Architecture|Miniature architecture]] wiki page. (outdated)
+== Contributors ==
+Maintainers:
+* [http://maemo.org/profile/view/mikhas Michael Hasselmann]: lead developer
+* [http://maemo.org/profile/view/qgil Quim Gil]: UX & documentation
+Gave a big hand:
+* [http://maemo.org/profile/view/kore Dennis Stötzel]: chess logics
+* [http://maemo.org/profile/view/hasselmm Mathias Hasselmann]: veteran programmer
+* [http://gitorious.org/~Malcolm Dariusz Mikulski]: P2P telepathy integration
+Special thanks:
+* [http://maemo.org/profile/view/kittykat kittykat]: game icon
+* [http://en.wikipedia.org/wiki/User:Cburnett Colin M.L. Burnett]: free piece set used by Wikipedia