Contents of README files

[Genete]

I would like to update/improve the headers of the README files in the code.
Please take a look and propose some modifications if needed. They should be consistent with the “about” in the wiki.

for Synfig Studio:

          synfigstudio -- vector animation studio

synfig is a vector based 2D animation package. It is designed to be
capable of producing feature-film quality animation. It eliminates the
need for tweening, preventing the need to hand-draw each frame. synfig
features spatial and temporal resolution independence (sharp and smooth
at any resolution or framerate), high dynamic range images, and a
flexible plugin system.

synfigstudio is the animation studio for synfig and provides the GUI
interface to create synfig animations which are saved in synfig .sif
or .sifz format.

For Synfig core:

          synfig -- vector animation renderer

synfig is a vector based 2D animation package. It is designed to be
capable of producing feature-film quality animation. It eliminates the
need for tweening, preventing the need to hand-draw each frame. synfig
features spatial and temporal resolution independence (sharp and smooth
at any resolution or framerate), high dynamic range images, and a
flexible plugin system.

This package contains the renderer used to convert synfig .sif files to
raster images, videos and other formats. Layer types include geometric,
gradient, filter, distortion, transformation, fractal and others. Output
targets include JPEG, PNG, GIF, BMP, PPM, DV, OpenEXR, ffmpeg (MPEG1),
libavcodec (AVI), imagemagick (MIFF), yuv420p, MNG and others.

Thanks.
-G

[KonstantinDmitriev]

Suggestions:

synfigstudio provides GUI interface to create animation which are saved in synfig .sif or .sifz format.

This package contains console renderer used to produce raster images and video from .sif files. Output targets include JPEG, PNG, GIF, BMP, PPM, DV, OpenEXR, ffmpeg (MPEG1), libavcodec (AVI), imagemagick (MIFF), yuv420p, MNG and others.

[rylleman]

How about this?

Synfigstudio – vector animation studio

Synfig is a vector based 2D animation package. [br /]
It is designed to be an aid in producing feature-film quality animation. [It’s people who do the animation, not the software][br /]
It features a system for automatic tweening, preventing the need to hand-draw each frame. Synfig
features spatial and temporal resolution independence (Crisp images and smooth movement
at any resolution or framerate) and high dynamic range images. [Remove part about plugins since Synfig doesn’t have plugins…]

Synfigstudio is the front end for Synfig and provides the GUI
interface to create synfig animations which are saved in Synfig .sif
or .sifz format.

For Synfig core:

Synfig – vector animation renderer

Synfig is a vector based 2D animation package… [Same as previous]

This package contains the renderer used to convert synfig .sif files to
raster images, videos and other formats. Layer types include geometric,
gradient, filter, distortion, transformation, fractal and others. Output
targets include JPEG, PNG, GIF, BMP, PPM, DV, OpenEXR, ffmpeg (MPEG1),
libavcodec (AVI), imagemagick (MIFF), yuv420p, MNG and others.

[edit: accidently edited this entry rather than quote myself so it’s now recreated and may differ a bit from original…]

[pixelgeek]

FFMpeg more than just mpeg1 now

Any reason for only using lower case for ‘synfig’?

[oho]

@pixelgeek

Any reason for only using lower case for ‘synfig’?

yep and we should use one way of spelling SynfigStudio / Synfig Studio / Synfigstudio as well… for all docs…
or is it Synfig Animation Studio?

[Genete]

@pixelgeek

Any reason for only using lower case for ‘synfig’?

Yes.
synfig is the name of the executable of the Synfig program as well as synfigstudio is the name of the Synfig Studio program.

The first time the README file appeared it was written in lower case by pabs in the release of synfig 0.61.06 and said basically the same than today.

yep and we should use one way of spelling SynfigStudio / Synfig Studio / Synfigstudio as well… for all docs…
or is it Synfig Animation Studio?

That is another discussion that I wanted to have too. We should formerly give it a name and just one name. I have some preferences on this that I want to share:

synfig: is the command to invoke renderer. It should be written in lowercase and if appear in the wiki it should use some special font only used for commands from the console.
synfigstudio: is the command used to invoke the GUI. Same comments as for synfig.
Synfig Project: it is the name of the project that sums: software, packaging, documentation, website, etc.
Synfig: it is the general name used to refer to the program used in any article or in the documentation when it doesn’t refers specifically to synfig or synfigstudio.
Synfig Studio: It is the name what should be used when referring to the GUI in an article or in the documentation.

Personally I don’t like the compound Synfig Animation Studio, but I can understand and will back any other opinion on that.

Forums, wiki, website, sourceforge, etc. should use those words with those rules (or the ones that we agree) from now an on. There are lot of places where the same things are named differently.

Thoughts?
-G

[oho]

I’m new here, so that is perfectly ok with me, any comments from the senior staff?
I’ll put these rules in to the writer’s doc as soon as accepted (or not commented for a while)…

[pixelgeek]

Sounds like a good set of guidelines to me.

[KonstantinDmitriev]

Soudns good. I don’t like Synfig Animation Studio too.

[oho]

added this to the Writer’s Doc…