]> git.sesse.net Git - casparcg/commitdiff
Updated README
authorJonas Hummelstrand <jonas@hummelstrand.com>
Wed, 9 Sep 2015 08:43:45 +0000 (10:43 +0200)
committerJonas Hummelstrand <jonas@hummelstrand.com>
Wed, 9 Sep 2015 08:43:45 +0000 (10:43 +0200)
Still missing: Linux requirements and installation procedure

README.txt

index f7dc40785f76d5680b984d1744f6ab53fcd9f42a..ea26b78a45cadc2c754e086c86447fe739afe650 100644 (file)
@@ -1,19 +1,25 @@
+=========================================================================================\r
 CasparCG Server 2.1 alpha\r
-============================\r
+=========================================================================================\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
 CasparCG Server has been in 24/7 broadcast production since 2006.\r
+The included software is provided as-is by Sveriges Televison AB.\r
 \r
 This release is considered untested and unstable, and is NOT intended for use in\r
-professional production.\r
+professional production. Stable and production-proven versions can be downloaded \r
+at http://casparcg.com/download/\r
 \r
 Alpha and beta builds are available at http://builds.casparcg.com/\r
 \r
-More information about CasparCG is available at http://casparcg.com/\r
+More information about CasparCG is available at http://casparcg.com/ and\r
+in the forum at http://casparcg.com/forum/\r
+\r
+\r
 \r
 \r
 COMMON SYSTEM REQUIREMENTS FOR WINDOWS AND LINUX \r
-------------------------------------------------\r
+=========================================================================================\r
 1. Intel processor capable of using SSSE3 instructions. \r
    Please refer to\r
    http://en.wikipedia.org/wiki/SSSE3 for a complete list.\r
@@ -25,9 +31,10 @@ COMMON SYSTEM REQUIREMENTS FOR WINDOWS AND LINUX
    using the built-in GPU that exists in many CPUs. Your playback performance\r
    might suffer if using a built-in GPU.\r
    \r
+\r
    \r
 SYSTEM REQUIREMENTS FOR WINDOWS\r
--------------------------------\r
+=========================================================================================\r
 1. Windows 7 (64-bit) or Windows 8 (64-bit)\r
    CasparCG Server has also been used successfully on Windows 7 (32-bit) \r
    and Windows XP SP2 (32-bit only.)\r
@@ -40,15 +47,16 @@ SYSTEM REQUIREMENTS FOR WINDOWS
    See link in the 'INSTALLATION ON WINDOWS' section below.\r
    \r
    \r
+\r
 SYSTEM REQUIREMENTS FOR LINUX\r
------------------------------\r
+=========================================================================================\r
 1. XXXXXXXXXXXXX\r
    \r
 \r
 \r
 \r
 INSTALLATION ON WINDOWS\r
------------------------\r
+=========================================================================================\r
 1. Check that your system meets the requirements above.\r
 \r
 2. Unzip and place the "CasparCG Server" folder anywhere you like.\r
@@ -61,44 +69,101 @@ INSTALLATION ON WINDOWS
 \r
 \r
 \r
+INSTALLATION ON LINUX\r
+=========================================================================================\r
+1. Check that your system meets the requirements above.\r
+\r
+2. XXXXXXXXXXXXX\r
+\r
+\r
+\r
 INSTALLATION OF ADDITIONAL NON-GPL SOFTWARE\r
--------------------------------------------\r
+=========================================================================================\r
 - For Flash template support (Windows only):\r
 \r
   1. Uninstall any previous version of the Adobe Flash Player using this file:\r
-     http://download.macromedia.com/get/flashplayer/current/support/uninstall_flash_player.exe\r
+http://download.macromedia.com/get/flashplayer/current/support/uninstall_flash_player.exe\r
   2. Download and unpack\r
-     http://download.macromedia.com/pub/flashplayer/installers/archive/fp_11.8.800.94_archive.zip\r
+http://download.macromedia.com/pub/flashplayer/installers/archive/fp_11.8.800.94_archive.zip\r
   3. Install Adobe Flash Player 11.8.800.94 from the unpacked archive:\r
      fp_11.8.800.94_archive\11_8_r800_94\flashplayer11_8r800_94_winax.exe\r
 \r
-- For NewTek iVGA support (Windows only), please download and install the following driver:\r
-  http://new.tk/NetworkSendRedist\r
+- For NewTek iVGA support (Windows only), please download and install the following \r
+  driver:  http://new.tk/NetworkSendRedist\r
+\r
 \r
 \r
 CONFIGURATION\r
--------------\r
-1. Configure the server by editing the self-documented casparcg.config file in a\r
+=========================================================================================\r
+1. Configure the server by editing the self-documented 'casparcg.config' file in a\r
    text editor.\r
 \r
-2. Start the "casparcg.exe" program.\r
+2. On Windows, start the "casparcg.exe" program, or on Linux start the 'bin/casparcg' \r
+   program.\r
 \r
 3. Connect to the Server from a client software, such as the "CasparCG Client"\r
    which is available as a separate download.\r
 \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
+\r
+\r
+\r
 LICENSING\r
----------\r
-CasparCG is distributed under the GNU General Public License GPLv3 or\r
-higher, please see LICENSE.TXT for details.\r
+=========================================================================================\r
+CasparCG is distributed under the GNU General Public \r
+License GPLv3 or higher, see the file COPYING.TXT for details. \r
 \r
-The included software is provided as-is by Sveriges Televison AB.\r
-More information is available at http://casparcg.com/\r
+More information, samples and documentation at: \r
+http://casparcg.com/\r
+http://casparcg.com/forum/\r
+http://casparcg.com/wiki/\r
+\r
+\r
+CasparCG Server 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 Server uses the Threading Building Blocks \r
+(http://www.threadingbuildingblocks.org/) library under the GPLv2 Licence.\r
+\r
+CasparCG Server uses FreeImage (http://freeimage.sourceforge.net/) under the GPLv2.\r
+\r
+CasparCG Server uses SFML (http://www.sfml-dev.org/) under the zlib/libpng License.\r
+\r
+CasparCG Server uses GLEW (http://glew.sourceforge.net) under the modified BSD license.\r
+\r
+CasparCG Server uses boost (http://www.boost.org/) under the Boost Software License, \r
+version 1.0.\r
+\r
+\r
+\r
+\r
+AUTHORS - People who have developed the CasparCG Server software\r
+==========(sorted alphabetically by last name)==================\r
+Niklas Andersson   (Server 1.0-1.8)\r
+Andreas Jeansson    (TemplateHost)\r
+Robert Nagy        (Server 1.7-2.x)\r
+Helge Norberg     (Server 2.x)\r
+\r
+\r
+\r
+CREDITS - People who have contributed to the CasparCG Project\r
+==========(sorted alphabetically by last name)===============\r
+Niklas  Andersson\r
+Jonas   Hummelstrand    (jonas @ superfly.tv)\r
+Andreas Jeansson        (andreas.jeansson @ svt.se)\r
+Peter   Karlsson        (peter.p.karlsson @ svt.se)\r
+Jeff    Lafforgue\r
+Andy    Mace\r
+Robert  Nagy            (ronag89 @ gmail.com)\r
+Helge   Norberg         (helge.norberg @ svt.se)\r
+Thomas  R. Kaltz III\r
+Olle    Soprani\r