Difference between revisions of "Development guide"

From MythTV Official Wiki
Jump to: navigation, search
m (typo)
(Things you can work on: Added comment by Stuart Morgan from mythtv-dev mailing list.)
(15 intermediate revisions by 10 users not shown)
Line 4: Line 4:
 
=== Getting started ===
 
=== Getting started ===
  
The simplest and fastest way to get started coding on MythTV is simply by downloading the code(from subversion), compiling and running it on your machine. To do this just simply follow any installation manual for MythTV. We suggest you use:  
+
The simplest and fastest way to get started coding on MythTV is simply by downloading the code, compiling it, and running it on your machine. To do this just simply follow any installation manual for MythTV. We suggest you use:
* the instruction in the [http://www.mythtv.org/modules.php?name=MythInstall manual] (chapter: Manually building MythTV);
+
* one of the [[:Category:Distribution_Specific_Install_Guides|Distribution Specific Install Guides]] (e.g. Ubuntu-8.10 Source Install);
* one of the [[:Category:Distribution_Specific_Install_Guides|Distribution Specific Install Guides]] (e.g. Ubuntu-8.10 Source Install).  
+
* the instruction in the [http://www.mythtv.org/modules.php?name=MythInstall manual] (chapter: Manually building MythTV).
  
 +
Of course you can also choose to combine these to your liking (sometimes one tutorial explains certain topics better than the other). After this you can experiment with the code, recompiling it and test it on your machine. When you're familiar with the code you could try to pick-up a ticket to solve a bug or build a new feature.
  
Of course you can also choose to combine these to your liking (sometimes one tutorial explains certain topics better than the other). After this you can experiment with the code, recompiling it and test it on your machine. When your familiar with the code you could try to pick-up a ticket to solve a bug or build a new feature.
+
=== Things you can work on ===
  
 +
You can work on MythTV by picking up a ticket or by implementing a new feature. Before starting on either one, you should let others know about your intentions by posting this to the [[Community | developer-mailinglist]]. Visit our [http://code.mythtv.org/trac/ tracker] to find out what you can work on.
 +
 +
The following is from a comment by Stuart Morgan.
 +
 +
"We will generally accept patches against code written by MythTV developers. I stress that last part because the example you chose, RTjpegN.cpp, is in fact third party code that we've included into our code base, we normally don't do code formatting and correctness fixes for those because it would make re- syncing them harder. RTjpeg may even be dropped in favour of more modern codecs. If you do supply patches, please split them up into bite-size chunks, preferably not touching multiple libs, or too many files at once. This will make them easier to review and easier to apply, especially if one of the files changes before we can get to that point."
  
 
=== When your code is ready ===
 
=== When your code is ready ===
Line 35: Line 41:
  
  
Theming can be as simple and complex as you want it to be. The best way to get started building your own theme is by experimenting with an existing theme. Learn more about this '''[[theme development guide | here]]'''.
+
Theming can be as simple and complex as you want it to be. The best way to get started building your own theme is by experimenting with an existing theme. Learn more about this in the '''[[MythUI Theme Development]]''' guide.
 +
 
 +
=== Translations ===
 +
 
 +
If you have language skills, you can also help out by translating MythTV into other languages. Read more about it '''[[Translation | here]]''' and join the mailing list [http://www.mythtv.org/mailman/listinfo/mythtv-translators here].
  
  
Line 45: Line 55:
 
=== I've got this great idea... ===
 
=== I've got this great idea... ===
  
Every project has a leader, MythTV is lead by its creator Isaac. But some users have taken the time to suggest items to go on a [[Feature Wishlist]]. If you are a developer looking for a project, this might be a place look for some ideas proposed from the user community.  
+
Every project has a leader, MythTV is led by its steering committee. But some users have taken the time to suggest items to go on a [[Feature Wishlist]]. If you are a developer looking for a project, this might be a place look for some ideas proposed from the user community.  
  
  
Understand that these features may not represent what the project maintainers are looking for. A quick note to the myth-dev mailing list with your intentions will often result in feedback on the viability of your ideas in the project.
+
Understand that these features may not represent what the project maintainers are looking for. A quick note to the mythtv-dev mailing list with your intentions will often result in feedback on the viability of your ideas in the project.
 
+
  
 
=== Your idea might already exist ===
 
=== Your idea might already exist ===
  
There is a change your idea already exist -- it's a big project, and the features are sometimes a little tricky to find. Before spending time developing a new concept, try these steps:
+
There is a chance your idea already exists -- it's a big project, and the features are sometimes a little tricky to find. Before spending time developing a new concept, try these steps:
  
* Look through all of the settings pages in [[MythFrontend]] and setup.  Sometimes the feature you want isn't in the place you'd expect, or it's using a different name.
+
* Look through all of the settings pages in [[mythfrontend]] and setup.  Sometimes the feature you want isn't in the place you'd expect, or it's using a different name.
* Read the [http://svn.mythtv.org/trac/browser/trunk/mythtv/keys.txt keys.txt] file in the Myth distribution.  Many options are documented here, and you may not know of their existence.
+
* Read the [https://github.com/MythTV/mythtv/blob/master/mythtv/keys.txt keys.txt] file in the MythTV distribution.  Many options are documented here, and you may not know of their existence.
* [http://svn.mythtv.org/trac/report Search Trac reports] to see if someone's submitted a bug report or feature request.  You may be able to help by adding more information and clarifying the original report.
+
* [http://code.mythtv.org/trac/report Search Trac reports] to see if someone's submitted a bug report or feature request.  You may be able to help by adding more information and clarifying the original report.
 
* [http://gossamer-threads.com/lists/mythtv/dev/ Search the mythtv-dev archive] to see if someone's already discussed the feature.  It may have been rejected because of some unforeseen consequence, or someone may already be working on it.
 
* [http://gossamer-threads.com/lists/mythtv/dev/ Search the mythtv-dev archive] to see if someone's already discussed the feature.  It may have been rejected because of some unforeseen consequence, or someone may already be working on it.
 
  
 
=== Some helpful pages to keep close ===
 
=== Some helpful pages to keep close ===
  
If you are new to developing Myth, these pages can help you through the process:
+
If you are new to developing MythTV, these pages can help you through the process:
  
 
* [http://www.mythtv.org/mailman/listinfo/mythtv-dev/ mythtv-dev mailing list] - The mailing list developers use to communicate to each other.
 
* [http://www.mythtv.org/mailman/listinfo/mythtv-dev/ mythtv-dev mailing list] - The mailing list developers use to communicate to each other.
 
* [[Submitting Bug Fixes]] - How to submit your bug fixes when your code is ready for the public.
 
* [[Submitting Bug Fixes]] - How to submit your bug fixes when your code is ready for the public.
 
* [[Coding Standards]] - Some guidelines for writing code.
 
* [[Coding Standards]] - Some guidelines for writing code.
* [http://svn.mythtv.org/trac/ MythTV Trac server] - Trac startpage with relevant coding info
+
* [http://code.mythtv.org/trac/ MythTV Trac server] - Trac startpage with relevant coding info
 
* [http://www.mythtv.org//modules.php?name=MythInfo mailinglist and more information]
 
* [http://www.mythtv.org//modules.php?name=MythInfo mailinglist and more information]
 
* [http://www.cuymedia.net/doxygen-dev-docs/html/ 0.20.2 (Stable) Code Documentation]
 
* [http://www.cuymedia.net/doxygen-dev-docs/html/ 0.20.2 (Stable) Code Documentation]
 
* [http://miffteevee.co.uk/documentation/development/ Trunk  (Development) Code Documentation]
 
* [http://miffteevee.co.uk/documentation/development/ Trunk  (Development) Code Documentation]
* [[Developing_in_Eclipse_on_Win32|Developing in Eclipse on Win32]]
+
* [[Developing in Eclipse on Win32]]
 +
* [[Developing in Eclipse on Linux]]
  
  
Line 79: Line 88:
 
[[Category:Plugins]]
 
[[Category:Plugins]]
 
[[Category:HOWTO]]
 
[[Category:HOWTO]]
[[Category:Knowledge Base]]
 
[[Category:Themes]]
 

Revision as of 08:14, 10 October 2012

MythTV is primarily written in C++. Feel free to talk to us about your code and experiments in our mailing lists and chat groups or code something and submit it as a patch or feature to us.


Getting started

The simplest and fastest way to get started coding on MythTV is simply by downloading the code, compiling it, and running it on your machine. To do this just simply follow any installation manual for MythTV. We suggest you use:

Of course you can also choose to combine these to your liking (sometimes one tutorial explains certain topics better than the other). After this you can experiment with the code, recompiling it and test it on your machine. When you're familiar with the code you could try to pick-up a ticket to solve a bug or build a new feature.

Things you can work on

You can work on MythTV by picking up a ticket or by implementing a new feature. Before starting on either one, you should let others know about your intentions by posting this to the developer-mailinglist. Visit our tracker to find out what you can work on.

The following is from a comment by Stuart Morgan.

"We will generally accept patches against code written by MythTV developers. I stress that last part because the example you chose, RTjpegN.cpp, is in fact third party code that we've included into our code base, we normally don't do code formatting and correctness fixes for those because it would make re- syncing them harder. RTjpeg may even be dropped in favour of more modern codecs. If you do supply patches, please split them up into bite-size chunks, preferably not touching multiple libs, or too many files at once. This will make them easier to review and easier to apply, especially if one of the files changes before we can get to that point."

When your code is ready

When your code is ready for the public, check the Submitting Bug Fixes page for information on how this is done.


How we work together

Almost all of the development activity goes through the mythtv-dev mailing list. When you have an interesting idea, subscribe to mythtv-dev, review its archive, and ask if anybody else is working on it. Some people might want to help you with figuring things out, and on the other hand, you might also be of assistance to existing efforts.


There is also the possibility to chat in realtime with other developers as you can findout here.


Plugins

Users have the possibility to extend their system with extra functionality by simply adding plugins. Users and developers can write their own plugins that run within MythTV and can be controlled by remote. A fast and easy way to get started is by taking a small existing plugin to start with. You can learn more about this here.


Themes

If you are more into design and graphics you will like the theme possibilities in MythTV to create new looks for the users to look at.


Theming can be as simple and complex as you want it to be. The best way to get started building your own theme is by experimenting with an existing theme. Learn more about this in the MythUI Theme Development guide.

Translations

If you have language skills, you can also help out by translating MythTV into other languages. Read more about it here and join the mailing list here.


Still not sure how to help?

Visit our IRC-based development discussions or send us a message through the mailing list. You can find more about this here.


I've got this great idea...

Every project has a leader, MythTV is led by its steering committee. But some users have taken the time to suggest items to go on a Feature Wishlist. If you are a developer looking for a project, this might be a place look for some ideas proposed from the user community.


Understand that these features may not represent what the project maintainers are looking for. A quick note to the mythtv-dev mailing list with your intentions will often result in feedback on the viability of your ideas in the project.

Your idea might already exist

There is a chance your idea already exists -- it's a big project, and the features are sometimes a little tricky to find. Before spending time developing a new concept, try these steps:

  • Look through all of the settings pages in mythfrontend and setup. Sometimes the feature you want isn't in the place you'd expect, or it's using a different name.
  • Read the keys.txt file in the MythTV distribution. Many options are documented here, and you may not know of their existence.
  • Search Trac reports to see if someone's submitted a bug report or feature request. You may be able to help by adding more information and clarifying the original report.
  • Search the mythtv-dev archive to see if someone's already discussed the feature. It may have been rejected because of some unforeseen consequence, or someone may already be working on it.

Some helpful pages to keep close

If you are new to developing MythTV, these pages can help you through the process: