]> git.sesse.net Git - casparcg/blobdiff - README.txt
Merge pull request #145 from cambell-prince/ffmpeg-dshowparams
[casparcg] / README.txt
index 2e30261ebb458527e7819710d64a81a750fecc47..28a93de9b056968eb4a5805ad7326ba52d2690cc 100644 (file)
@@ -1,45 +1,93 @@
-CasparCG Video and Graphics Playout Server\r
-===============================================\r
+CasparCG Server 2.0.4 Beta 1\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 software used to\r
+play out and record professional graphics, audio and video to multiple outputs.\r
+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
-http://casparcg.com/wiki/\r
+This release is NOT considered tested and stable, and it is NOT intended for use\r
+in professional production. Please use CasparCG Server 2.0.3 if you need \r
+proven stability!\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 been tested on\r
+   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 strongly\r
+   recommended!\r
+   Please check your card's capabilities at:\r
+   http://en.wikipedia.org/wiki/Comparison_of_Nvidia_graphics_processing_units\r
+   Make sure that you have the latest drivers installed:\r
+   http://www.nvidia.com/Download/index.aspx?lang=en-us%20nVidia%20drivers\r
+\r
+   Experimental support for AMD/ATI cards has been added, but it has not been\r
+   fully tested.\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
-CasparCG uses FFmpeg(http://ffmpeg.org/) under the GPLv2 Licence. \r
-FFmpeg is a trademark of Fabrice Bellard, originator of the FFmpeg project.\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
-CasparCG uses the Threading Building Blocks(http://www.threadingbuildingblocks.org/) library under the GPLv2 Licence.\r
+The latest system recommendations are available at:\r
+http://casparcg.com/wiki/CasparCG_Server#System_Requirements\r
 \r
-CasparCG uses FreeImage(http://freeimage.sourceforge.net/) under the GPLv2.\r
 \r
-CasparCG uses SFML(http://www.sfml-dev.org/) under the zlib/libpng License.\r
+INSTALLATION\r
+------------\r
 \r
-CasparCG uses Glee(http://elf-stone.com/) under the modified BSD license.\r
+1. Check that your system meets the requirements above.\r
 \r
-CasparCG uses boost(http://www.boost.org/) under the Boost Software License, Version 1.0.\r
+2. Unzip and place the "CasparCG Server 2.0.4 Beta 1" folder anywhere you like.\r
 \r
-AUTHORS - People who have written the CasparCG Server Software (sorted alphabetically by last name).\r
-================================================\r
+3. Install "Microsoft Visual C++ 2010 Redistributable Package" from\r
+   http://www.microsoft.com/download/en/details.aspx?id=5555\r
 \r
-       Niklas Andersson (1.0-1.8)\r
-       Robert Nagy              (1.7-2.0+)\r
-       Peter Karlsson   (2.0+)\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 "ClearType" font smoothing\r
+   as they can interfere with CasparCG Server's OpenGL features!\r
+\r
+6. Start the "casparcg_server.exe" program and configure the settings.\r
+\r
+7. Connect to the Server from a client, such as the CasparCG Client 2.0.4\r
+   (available as a 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
+Ask questions in the forum: http://casparcg.com/forum/\r
+\r
+\r
+LICENSING\r
+---------\r
 \r
-CREDITS - People who have contributed to the CasparCG Project (sorted alphabetically by last name).\r
-================================================\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