]> git.sesse.net Git - casparcg/blob - README.txt
Merge pull request #374 from hummelstrand/readme-2.1.0-update
[casparcg] / README.txt
1 =========================================================================================\r
2 CasparCG Server 2.1 alpha\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 The included software is provided as-is by Sveriges Televison AB.\r
8 \r
9 This release is considered untested and unstable, and is NOT intended for use in\r
10 professional production. Stable and production-proven versions can be downloaded \r
11 at http://casparcg.com/download/\r
12 \r
13 Alpha and beta builds are available at http://builds.casparcg.com/\r
14 \r
15 More information about CasparCG is available at http://casparcg.com/ and\r
16 in the forum at http://casparcg.com/forum/\r
17 \r
18 \r
19 \r
20 \r
21 COMMON SYSTEM REQUIREMENTS FOR WINDOWS AND LINUX \r
22 =========================================================================================\r
23 1. Intel processor capable of using SSSE3 instructions. \r
24    Please refer to\r
25    http://en.wikipedia.org/wiki/SSSE3 for a complete list.\r
26    While AMD processors might work, CasparCG Server has only been tested on\r
27    Intel processors.\r
28 \r
29 2. A graphics card (GPU) capable of OpenGL 3.0 is required.\r
30    We strongly recommend that you use a separate graphics card, and avoid\r
31    using the built-in GPU that exists in many CPUs. Your playback performance\r
32    might suffer if using a built-in GPU.\r
33    \r
34 \r
35    \r
36 SYSTEM REQUIREMENTS FOR WINDOWS\r
37 =========================================================================================\r
38 1. Windows 7 (64-bit) or Windows 8 (64-bit)\r
39    CasparCG Server has also been used successfully on Windows 7 (32-bit) \r
40    and Windows XP SP2 (32-bit only.)\r
41    NOT SUPPORTED: Windows 2003 Server and Windows Vista.\r
42    \r
43 2. Microsoft Visual C++ 2010 Redistributable Package must be installed.\r
44    See link in the 'INSTALLATION ON WINDOWS' section below.\r
45    \r
46 3. Microsoft .NET Framework 4.0 or later must be installed.\r
47    See link in the 'INSTALLATION ON WINDOWS' section below.\r
48    \r
49    \r
50 \r
51 SYSTEM REQUIREMENTS FOR LINUX\r
52 =========================================================================================\r
53 1. XXXXXXXXXXXXX\r
54    \r
55 \r
56 \r
57 \r
58 INSTALLATION ON WINDOWS\r
59 =========================================================================================\r
60 1. Check that your system meets the requirements above.\r
61 \r
62 2. Unzip and place the "CasparCG Server" folder anywhere you like.\r
63 \r
64 3. Install "Microsoft Visual C++ 2010 Redistributable Package" from\r
65    http://www.microsoft.com/download/en/details.aspx?id=5555\r
66    \r
67 4. Install "Microsoft .NET Framework" (version 4.0 or later) from\r
68    http://go.microsoft.com/fwlink/?LinkId=225702\r
69 \r
70 \r
71 \r
72 INSTALLATION ON LINUX\r
73 =========================================================================================\r
74 1. Check that your system meets the requirements above.\r
75 \r
76 2. XXXXXXXXXXXXX\r
77 \r
78 \r
79 \r
80 INSTALLATION OF ADDITIONAL NON-GPL SOFTWARE\r
81 =========================================================================================\r
82 - For Flash template support (Windows only):\r
83 \r
84   1. Uninstall any previous version of the Adobe Flash Player using this file:\r
85 http://download.macromedia.com/get/flashplayer/current/support/uninstall_flash_player.exe\r
86   2. Download and unpack\r
87 http://download.macromedia.com/pub/flashplayer/installers/archive/fp_11.8.800.94_archive.zip\r
88   3. Install Adobe Flash Player 11.8.800.94 from the unpacked archive:\r
89      fp_11.8.800.94_archive\11_8_r800_94\flashplayer11_8r800_94_winax.exe\r
90 \r
91 - For NewTek iVGA support (Windows only), please download and install the following \r
92   driver:  http://new.tk/NetworkSendRedist\r
93 \r
94 \r
95 \r
96 CONFIGURATION\r
97 =========================================================================================\r
98 1. Configure the server by editing the self-documented 'casparcg.config' file in a\r
99    text editor.\r
100 \r
101 2. On Windows, start the "casparcg.exe" program, or on Linux start the 'bin/casparcg' \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 \r
109 DOCUMENTATION\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 \r
118 \r
119 \r
120 LICENSING\r
121 =========================================================================================\r
122 CasparCG is distributed under the GNU General Public \r
123 License GPLv3 or higher, see the file COPYING.TXT for details. \r
124 \r
125 More information, samples and documentation at: \r
126 http://casparcg.com/\r
127 http://casparcg.com/forum/\r
128 http://casparcg.com/wiki/\r
129 \r
130 \r
131 CasparCG Server uses FFmpeg (http://ffmpeg.org/) under the GPLv2 Licence. \r
132 FFmpeg is a trademark of Fabrice Bellard, originator of the FFmpeg project.\r
133 \r
134 CasparCG Server uses the Threading Building Blocks \r
135 (http://www.threadingbuildingblocks.org/) library under the GPLv2 Licence.\r
136 \r
137 CasparCG Server uses FreeImage (http://freeimage.sourceforge.net/) under the GPLv2.\r
138 \r
139 CasparCG Server uses SFML (http://www.sfml-dev.org/) under the zlib/libpng License.\r
140 \r
141 CasparCG Server uses GLEW (http://glew.sourceforge.net) under the modified BSD license.\r
142 \r
143 CasparCG Server uses boost (http://www.boost.org/) under the Boost Software License, \r
144 version 1.0.\r
145 \r
146 \r
147 \r
148 \r
149 AUTHORS - People who have developed the CasparCG Server software\r
150 ==========(sorted alphabetically by last name)==================\r
151 Niklas Andersson   (Server 1.0-1.8)\r
152 Andreas Jeansson    (TemplateHost)\r
153 Robert Nagy        (Server 1.7-2.x)\r
154 Helge Norberg     (Server 2.x)\r
155 \r
156 \r
157 \r
158 CREDITS - People who have contributed to the CasparCG Project\r
159 ==========(sorted alphabetically by last name)===============\r
160 Niklas  Andersson\r
161 Jonas   Hummelstrand    (jonas @ superfly.tv)\r
162 Andreas Jeansson        (andreas.jeansson @ svt.se)\r
163 Peter   Karlsson        (peter.p.karlsson @ svt.se)\r
164 Jeff    Lafforgue\r
165 Andy    Mace\r
166 Robert  Nagy            (ronag89 @ gmail.com)\r
167 Helge   Norberg         (helge.norberg @ svt.se)\r
168 Thomas  R. Kaltz III\r
169 Olle    Soprani\r