]> git.sesse.net Git - casparcg/blob - README
Fix a few Clang warnings.
[casparcg] / README
1 CasparCG Server 2.1.0 Beta 2\r
2 ============================\r
3 \r
4 Thank you for your interest in CasparCG Server, a professional software used to\r
5 play out and record professional graphics, audio and video to multiple outputs.\r
6 CasparCG Server has been in 24/7 broadcast production since 2006.\r
7 \r
8 This release is considered beta, and is NOT intended for use in professional\r
9 production. Stable and production-proven versions can be downloaded at\r
10 http://casparcg.com/download/\r
11 \r
12 Alpha and beta builds are available at http://builds.casparcg.com/\r
13 \r
14 More information about CasparCG is available at http://casparcg.com/ and\r
15 in the forum at http://casparcg.com/forum/\r
16 \r
17 \r
18 COMMON SYSTEM REQUIREMENTS FOR WINDOWS AND LINUX\r
19 ------------------------------------------------\r
20 \r
21 - Intel processor capable of using SSSE3 instructions.\r
22   Please refer to\r
23   http://en.wikipedia.org/wiki/SSSE3 for a complete list.\r
24   While AMD processors might work, CasparCG Server has only been tested on Intel\r
25   processors.\r
26 \r
27 - A graphics card (GPU) capable of OpenGL 3.0 is required.\r
28   We strongly recommend that you use a separate graphics card, and avoid\r
29   using the built-in GPU that exists in many CPUs. Your playback performance\r
30   might suffer if using a built-in GPU.\r
31 \r
32 \r
33 SYSTEM REQUIREMENTS FOR WINDOWS\r
34 -------------------------------\r
35 \r
36 - Windows 7 (64-bit)\r
37   CasparCG Server has also been used successfully on Windows 8 (64-bit).\r
38   NOT SUPPORTED: 32-bit Windows versions and Windows 2003 Server.\r
39 \r
40 - Microsoft Visual C++ 2015 Redistributable Package must be installed.\r
41   See link in the 'INSTALLATION ON WINDOWS' section below.\r
42 \r
43 \r
44 SYSTEM REQUIREMENTS FOR LINUX\r
45 -----------------------------\r
46 \r
47 - Ubuntu Desktop 14.04.3 LTS 64-bit.\r
48   Other distributions might be ABI compatible and supported but not tested.\r
49 \r
50 - An Nvidia graphics card.\r
51   Other manufacturers might also work but are untested.\r
52 \r
53 \r
54 INSTALLATION ON WINDOWS\r
55 -----------------------\r
56 \r
57 1. Check that your system meets the requirements above.\r
58 \r
59 2. Unzip and place the "CasparCG Server" folder anywhere you like.\r
60 \r
61 3. Install "Microsoft Visual C++ Redistributable for Visual Studio 2015" from\r
62    https://www.microsoft.com/en-us/download/details.aspx?id=48145\r
63 \r
64 \r
65 INSTALLATION ON LINUX\r
66 ---------------------\r
67 \r
68 1. Check that your system meets the requirements above.\r
69 \r
70 2. Unpack and place the "CasparCG Server" folder anywhere you like.\r
71 \r
72 3. If using an Nvidia graphics card enable the use of "NVIDIA binary driver"\r
73    under "Software & Updates -- Additional Drivers".\r
74 \r
75 \r
76 INSTALLATION OF ADDITIONAL NON-GPL SOFTWARE\r
77 -------------------------------------------\r
78 \r
79 - For Flash template support (Windows only):\r
80 \r
81   1. Uninstall any previous version of the Adobe Flash Player using this file:\r
82      http://download.macromedia.com/get/flashplayer/current/support/uninstall_flash_player.exe\r
83 \r
84   2. Download and unpack\r
85      http://download.macromedia.com/pub/flashplayer/installers/archive/fp_11.8.800.94_archive.zip\r
86 \r
87   3. Install Adobe Flash Player 11.8.800.94 from the unpacked archive:\r
88      fp_11.8.800.94_archive\11_8_r800_94\flashplayer11_8r800_94_winax.exe\r
89 \r
90 - For NewTek iVGA support (Windows only), please download and install the\r
91   following driver:\r
92   http://new.tk/NetworkSendRedist\r
93 \r
94 \r
95 CONFIGURATION\r
96 -------------\r
97 \r
98 1. Configure the server by editing the self-documented "casparcg.config" file in\r
99    a text editor.\r
100 \r
101 2. On Windows, start the "casparcg.exe" program, or on Linux start the "run.sh"\r
102    program.\r
103 \r
104 3. Connect to the Server from a client software, such as the "CasparCG Client"\r
105    which is available as a separate download.\r
106 \r
107 \r
108 DOCUMENTATION\r
109 -------------\r
110 \r
111 The most up-to-date documentation is always available at\r
112 http://casparcg.com/wiki/\r
113 \r
114 Ask questions in the forum: http://casparcg.com/forum/\r
115 \r
116 \r
117 LICENSING\r
118 ---------\r
119 \r
120 CasparCG is distributed under the GNU General Public License GPLv3 or higher,\r
121 see the file LICENSE.txt for details.\r
122 \r
123 More information, samples and documentation at:\r
124 \r
125 http://casparcg.com/\r
126 http://casparcg.com/forum/\r
127 http://casparcg.com/wiki/\r
128 \r
129 CasparCG Server uses FFmpeg (http://ffmpeg.org/) under the GPLv2 Licence.\r
130 FFmpeg is a trademark of Fabrice Bellard, originator of the FFmpeg project.\r
131 \r
132 CasparCG Server uses the Threading Building Blocks\r
133 (http://www.threadingbuildingblocks.org/) library under the GPLv2 Licence.\r
134 \r
135 CasparCG Server uses FreeImage (http://freeimage.sourceforge.net/) under the\r
136 GPLv2 License.\r
137 \r
138 CasparCG Server uses SFML (http://www.sfml-dev.org/) under the zlib/libpng\r
139 License.\r
140 \r
141 CasparCG Server uses GLEW (http://glew.sourceforge.net) under the modified BSD\r
142 License.\r
143 \r
144 CasparCG Server uses boost (http://www.boost.org/) under the Boost Software\r
145 License, version 1.0.\r
146 \r