]> git.sesse.net Git - casparcg/blobdiff - README.txt
Updated CHANGES.txt
[casparcg] / README.txt
index 8714842c8c407b35eb4c93958621d6ad5a7c3cd7..245cbf3603ac052bf46b3b0e9a481e08d39d0112 100644 (file)
-CasparCG Video and Graphics Playout Server\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
+Thank you for your interest in CasparCG Server, a professional \r
+software used to play out and record professional graphics, audio and video \r
+to multiple outputs. It has been in 24/7 broadcast production since 2006.\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
+This release is considered tested and stable, and is intended for use in\r
+professional production.\r
+\r
+More information is available at http://casparcg.com/\r
+\r
+\r
+SYSTEM REQUIREMENTS\r
+-------------------\r
+\r
+1. Intel processor capable of using SSSE3 instructions. Please refer to\r
+   http://en.wikipedia.org/wiki/SSSE3 for a complete list.\r
+   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 this software has also been used\r
+   successfully on Windows 7 (32-bit) and Windows XP SP2 (32-bit only.) \r
+   Using CasparCG Server on Windows 8 and Windows Vista is untested and \r
+   is not recommended!\r
+   \r
+3. An NVIDIA graphics card (GPU) capable of OpenGL 3.0 or higher is required! \r
+   Please check your card's capabilities at: \r
+   http://en.wikipedia.org/wiki/Comparison_of_Nvidia_graphics_processing_units\r
+\r
+Also make sure that you have the latest drivers installed:\r
+   http://www.nvidia.com/Download/index.aspx?lang=en-us%20nVidia%20drivers\r
+   \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
+6. Make sure you turn off Windows' "Aero" theme and "ClearType" font smoothing \r
+   as they have been known to interfere with transparency in Flash templates, \r
+   and can also cause problems with Vsync when outputting to computer screens.\r
+\r
+The latest system 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" and ClearTyper as they can\r
+   interfere with 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) or the CasparCG Client 2.0 (available as a\r
+   separate download.)\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 libraries from the FFmpeg project under the \r
-GPLv2 Licence. FFmpeg is a trademark of Fabrice Bellard, originator \r
-of the FFmpeg project. Get more info about FFmpeg at: \r
-http://ffmpeg.org/\r
 \r
-CasparCG uses the Threading Building Blocks library under\r
-the GPLv2 Licence. Get more info on Threading Building Blocks at: \r
-http://www.threadingbuildingblocks.org/\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
-CasparCG uses FreeImage under the GPLv2. Get more info about FreeImage at: \r
-http://freeimage.sourceforge.net/\r
+* How to enable Screen consumer:\r
 \r
-CasparCG uses SFML under the zlib/libpng License. Get more info about SFML at:\r
-http://www.sfml-dev.org/\r
+  Open casparcg.config and use the following node for consumers:\r
 \r
-CasparCG uses Glee under the modified BSD license. Get more info about Glee at:\r
-http://elf-stone.com/\r
+  <consumers>\r
+      <screen />\r
+  </consumers>\r
 \r
-CasparCG uses boost under the Boost Software License, Version 1.0. Get more info about boost at:\r
-http://www.boost.org/\r
+* How to enable a DeckLink card and how to get video in and key output:\r
 \r
-AUTHORS\r
-================================================\r
+  Open casparcg.config and use the following node for consumers:\r
 \r
-These are the names of the people who have written the CasparCG Server Software.\r
-The names are sorted alphabetically by last name.\r
+  <consumers>\r
+      <decklink />\r
+  </consumers>\r
 \r
-       Niklas Andersson (1.0-1.8)\r
-       Robert Nagy              (1.7-2.0+)\r
-       Peter Karlsson   (2.0+)\r
+# Tip:\r
 \r
-CREDITS\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
-These are the names of the people who have contributed to the\r
-CasparCG Project. The names are sorted alphabetically by last name.\r
+CasparCG Client is distributed under the GNU General Public License GPLv3 or\r
+higher, see LICENSE.TXT for details.\r
 \r
-  Niklas Andersson             \r
-  Jonas Gustafsson             \r
-  Jonas Hummelstrand   \r
-  Andreas Jeansson             \r
-  Peter Karlsson               \r
-  Robert Nagy                  \r
-  Olle Soprani\r
+The included software is provided as-is by Sveriges Televison AB.\r
+More information is available at http://casparcg.com/\r