]> git.sesse.net Git - casparcg/blobdiff - README.txt
client: Use fixed 4096 size for messages.
[casparcg] / README.txt
index db2a58408e0138841d5f90dc44752e5d99650c3b..845667fc30d03dcea2f2f18af81fd71323d33535 100644 (file)
-CasparCG Video and Graphics Playout Server\r
-===============================================\r
+================================================================================\r
+CasparCG Server 2.0.3\r
+================================================================================\r
 \r
-Thank you for your interest in CasparCG. The included software\r
-is provided as-is by Sveriges Televison AB.\r
+SYSTEM REQUIREMENTS\r
+===================\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
+1. Intel processor (while AMD processors should work, CasparCG Server has only\r
+   been tested on Intel processors.)\r
+\r
+2. We recommend Windows 7 (64-bit,) but it has also been successfully used on \r
+   Windows 7 (32-bit) and Windows XP SP2 (32-bit only.)\r
+   \r
+3. An OpenGL 3.0-capable graphics card from NVIDIA is required to run \r
+   CasparCG Server 2.0. Also make sure that you have installed the latest\r
+   drivers.\r
+   Please check your card's capabilities at: \r
+   http://en.wikipedia.org/wiki/Comparison_of_Nvidia_graphics_processing_units\r
+   Graphics cards from other manufacturers _may_ work but have not been tested.\r
+\r
+4. Microsoft Visual C++ 2010 Redistributable Package must be installed.\r
+   Free download at:\r
+   http://www.microsoft.com/download/en/details.aspx?id=5555\r
+\r
+5. You must have Flash Player 10.3 or later installed (an installer can be found\r
+   in the "Flash Player Installation" folder.)\r
+\r
+The latest recommendations are available at:\r
+http://casparcg.com/wiki/CasparCG_Server#System_Requirements\r
+\r
+\r
+INSTALLATION\r
+============\r
+\r
+1. Check that your system meets the requirements.\r
+\r
+2. Unzip and place the CasparCG Server 2.0.3 folder anywhere you like.\r
+\r
+3. Install "Microsoft Visual C++ 2010 Redistributable Package" from\r
+   http://www.microsoft.com/download/en/details.aspx?id=5555\r
+   \r
+4. Install "Flash Player 10.3.183.14" from the "Flash Player Installation"\r
+   folder.\r
+\r
+5. Make sure you turn off Windows' Aero Theme as it interferes with \r
+   CasparCG Server's OpenGL features!\r
+\r
+6. Configure the server settings in the "casparcg.config" text file.\r
+\r
+7. Start the "CasparCG.exe" program.\r
+\r
+8. Connect to the server from a client, such as the included CasparCG 2.0 Demo\r
+   Client (requires Adobe AIR.)\r
+\r
+\r
+DOCUMENTATION\r
+=============\r
+\r
+The most up-to-date documentation is always available at\r
 http://casparcg.com/wiki/\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
 \r
-CasparCG uses the Threading Building Blocks(http://www.threadingbuildingblocks.org/) library under the GPLv2 Licence.\r
+CONFIGURATION\r
+=============\r
+\r
+By default, CasparCG Server will look in the media folder for videos, audio and\r
+images files. Flash templates are stored in the templates folder. If you want to\r
+change the location (for example to a faster disk) you just change the paths in\r
+the casparcg.config file.\r
+\r
+* How to enable Screen consumer:\r
 \r
-CasparCG uses FreeImage(http://freeimage.sourceforge.net/) under the GPLv2.\r
+  Open casparcg.config and use the following node for consumers:\r
 \r
-CasparCG uses SFML(http://www.sfml-dev.org/) under the zlib/libpng License.\r
+  <consumers>\r
+      <screen/>\r
+  </consumers>\r
 \r
-CasparCG uses Glee(http://elf-stone.com/) under the modified BSD license.\r
+* How to enable a DeckLink card and how to get video in and key output:\r
 \r
-CasparCG uses boost(http://www.boost.org/) under the Boost Software License, Version 1.0.\r
+  Open casparcg.config and use the following node for consumers:\r
+\r
+  <consumers>\r
+      <decklink/>\r
+  </consumers>\r
+\r
+# Tip:\r
+\r
+At the bottom of the casparcg.config file you will find comments which document\r
+additional settings.\r
+\r
+\r
+LICENSING\r
+=========\r
 \r
-AUTHORS - People who have developed the CasparCG Server Software (sorted alphabetically by last name).\r
-================================================\r
+CasparCG Server is distributed under the GNU General Public License GPLv3 or\r
+higher, see LICENSE.TXT for details.\r
 \r
-       Niklas  Andersson       (Server 1.0-1.8)\r
-       Andreas Jeansson        (Template-Host)\r
-       Robert  Nagy            (Server 1.7-2.x)\r
-       \r
-CREDITS - People who have contributed to the CasparCG Project (sorted alphabetically by last name).\r
-================================================\r
+CREDITS - People who have contributed to the CasparCG Project\r
+==========(sorted alphabetically by last name)===============\r
 \r
-       Niklas  Andersson               (niklas.p.andersson@svt.se)\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                 (olle.soprani@svt.se)\r
+Niklas  Andersson\r
+Jonas   Hummelstrand\r
+Andreas Jeansson\r
+Peter   Karlsson\r
+Jeff    Lafforgue\r
+Andy    Mace\r
+Robert         Nagy\r
+Helge   Norberg\r
+Thomas  R. Kaltz III\r
+Olle    Soprani\r