]> git.sesse.net Git - casparcg/blobdiff - README.txt
Prepare for tag of 2.0.3 STABLE
[casparcg] / README.txt
index 87b78961ffadaed50788a7c32738a74bd606495f..8b08190cb96a700d06659e4952507f48198d969f 100644 (file)
@@ -1,45 +1,78 @@
+==========================================================================================================\r
 CasparCG Video and Graphics Playout Server\r
-===============================================\r
+==========================================================================================================\r
 \r
 Thank you for your interest in CasparCG. The included software\r
 is provided as-is by Sveriges Televison AB.\r
 \r
-LICENSING\r
-================================================\r
-CasparCG is distributed under the GNU General Public \r
-License GPLv3 or higher, see the file COPYING.TXT for details. \r
-More information, samples and documentation at: \r
-http://casparcg.com/\r
-http://casparcg.com/forum/\r
-http://casparcg.com/wiki/\r
+Please note that while the current CasparCG Client (version 1.8) will\r
+continue to work with CasparCG Server 2.0, you won't be able to\r
+trigger many of the new features. Please use the provided AIR app to\r
+try out the new functionality or add the new features to you \r
+control application (you can find the documentation on the wiki or ask in the forums). \r
+\r
+==========================================================================================================\r
+INSTALLATION\r
+==========================================================================================================\r
+\r
+You can place the CasparCG Server 2.0 folder anywhere you like, and even move it.\r
+\r
+If you don't already have Flash installed, use the bundled version in the Flash folder\r
+\r
+==========================================================================================================\r
+CONFIGURATION\r
+==========================================================================================================\r
+\r
+By default, CasparCG Server will look in the media folder \r
+for videos, audio and images files. Flash templates are stored in the\r
+templates folder. If you want to change the location (for example to a faster disk)\r
+you just change the paths in the casparcg.config file.\r
+\r
+* How to enable Screen consumer\r
 \r
-CasparCG uses FFmpeg(http://ffmpeg.org/) under the GPLv2 Licence. \r
-FFmpeg is a trademark of Fabrice Bellard, originator of the FFmpeg project.\r
+Open casparcg.config and use the following node for consumers:\r
 \r
-CasparCG uses the Threading Building Blocks(http://www.threadingbuildingblocks.org/) library under the GPLv2 Licence.\r
+<consumers>\r
+    <screen/>\r
+</consumers>\r
 \r
-CasparCG uses FreeImage(http://freeimage.sourceforge.net/) under the GPLv2.\r
+* How to enable a DeckLink card and how to get video in and key output.\r
 \r
-CasparCG uses SFML(http://www.sfml-dev.org/) under the zlib/libpng License.\r
+Open casparcg.config and use the following node for consumers:\r
 \r
-CasparCG uses Glee(http://elf-stone.com/) under the modified BSD license.\r
+<consumers>\r
+    <decklink/>\r
+</consumers>\r
 \r
-CasparCG uses boost(http://www.boost.org/) under the Boost Software License, Version 1.0.\r
+# Tip:\r
 \r
+At the bottom of the casparcg.config file you will find comments which document additional settings.\r
+\r
+==========================================================================================================\r
+LICENSING\r
+==========================================================================================================\r
+\r
+\r
+CasparCG is distributed under the GNU General Public License GPLv3 or higher, see COPYING.TXT for details.\r
+\r
+==========================================================================================================\r
 AUTHORS - People who have developed the CasparCG Server Software (sorted alphabetically by last name).\r
-================================================\r
+==========================================================================================================\r
+\r
+Niklas         Andersson   (Server 1.0-1.8)\r
+Andreas        Jeansson    (Template-Host)\r
+Robert         Nagy        (Server 1.7-2.x)\r
+Helge   Norberg     (Server 2.x)\r
 \r
-       Niklas  Andersson       (Server 1.0-1.8)\r
-       Andreas Jeansson        (Template-Host)\r
-       Robert  Nagy            (Server 1.7-2.x)\r
-       \r
+==========================================================================================================\r
 CREDITS - People who have contributed to the CasparCG Project (sorted alphabetically by last name).\r
-================================================\r
-\r
-       Niklas  Andersson                       \r
-       Jonas   Hummelstrand    (jonas.hummelstrand@svt.se)\r
-       Andreas Jeansson                (andreas.jeansson@svt.se)\r
-       Peter   Karlsson                (peter.p.karlsson@svt.se)\r
-       Robert  Nagy                    (robert.nagy@svt.se)\r
-       Olle    Soprani                 \r
-       Thomas  R. Kaltz III \r
+==========================================================================================================\r
+\r
+Niklas Andersson\r
+Jonas  Hummelstrand    (jonas.hummelstrand@svt.se)\r
+Andreas Jeansson        (andreas.jeansson@svt.se)\r
+Peter  Karlsson        (peter.p.karlsson@svt.se)\r
+Robert         Nagy            (robert.nagy@dfindredpatch.se, ronag89@gmail.com)\r
+Helge   Norberg         (helge.norberg@svt.se)\r
+Olle   Soprani \r
+Thomas         R. Kaltz III \r