Dev:Contribute to Code

From Synfig Studio :: Documentation
Revision as of 10:16, 28 April 2008 by SvH (Talk | contribs) (Getting the source)

Jump to: navigation, search


You should know by the history, that this program was initially written by an animation company, Voria Studios. Since the code of Synfig was released under GPL licence and turned into an open source project, there have been made some modifications to the code, which allows you to remove bugs and to add some new functionality.

The only documentation you can get, is the source-code itself and the automatically generated API docs by doxygen. This page tries to collect all the knowledge acquired by the current developers and to create typical guides for common tasks which would allow you to add new features and make the program grow.

Feel free to add here all the information you can get from the experience of reading and modifying the source code or simply add your request to get more details from coders more familiar with the source. Hopefully they will be able to tell you, how it works and where to dive in.

Common tasks

  • Write a (brief) man page for synfigstudio.
  • Expand the stub at wikipedia or translate it into your language.
  • Adding Layers to Synfig: this guide aids you to understand, how the layers work and how to add a new layer type.
  • Adding Panels to Synfigstudio: This guide explains, how to add a new panel and the objects on it.

Things you want to know about the code

  • Please add here a brief description of the things you want to know about the code and how to accomplish some task. Someone else will surely know it, and can help you to start developing on synfig.
  • Is there anywhere any kind of overview? Any sort of brief description of what each program does/is? Is synfigstudio the GUI for synfig? What's the ETL?

Documenting the code

It would be a good thing, if all the code documentation and what is being discovered were confirmed and inserted directly in the source code itself. This would allow doxygen to generate the API docs easily.

Please follow these doxygen rules to add documentation to the source code.

Getting the source

We use SVN to store all our sources. To check out the core part, you have to issue this command on your console:

svn co synfig-core

If you have installed a svn-client on your computer, you will get all important sources in a new created subfolder synfig-core, from where you have issued the above command.