Permalink
Browse files

update docs

svn path=/collective.transcode.recipe/trunk/; revision=121512
  • Loading branch information...
1 parent b77f702 commit c353e6e6c1045cf78df8aa7a3d53847c460bd38c @d-mo d-mo committed Jul 21, 2010
Showing with 47 additions and 56 deletions.
  1. +7 −0 CHANGES.txt
  2. +38 −0 README.txt
  3. +0 −50 collective/transcode/recipe/README.txt
  4. +2 −6 setup.py
View
@@ -1,3 +1,10 @@
+0.2 (2010-21-18)
+----------------
+
+- Release for collective.transcode.daemon 0.2
+ [dimo]
+
+
0.1 (2010-02-18)
----------------
View
@@ -0,0 +1,38 @@
+Introduction
+============
+
+A zc.buildout recipe that configures a collective.transcode.daemon instance
+
+For more info check out
+
+ * http://pypi.python.org/pypi/collective.transcode.daemon
+ * http://pypi.python.org/pypi/collective.transcode.star
+
+
+Supported options
+-----------------
+
+The recipe supports the following options:
+
+listen_host
+ hostname to listen
+
+listen_port
+ port to use
+
+videofolder
+ relative path of folder where transcoded videos are stored
+
+secret
+ a secret shared key used for authentication and encryption
+
+profiles
+ a python list of dicts specifying the supported transcoded
+ profiles. The dict should contain i) the id of the profile,
+ ii) the command to be executed with the first parameter to be
+ the input and the second the output file, and iii) the list
+ of supported mime types for this profile
+ e.g. profiles = [ {'id':'low', 'cmd':'scripts/lowQualityTranscode %s %s', 'supported_mime_types': ['video/mpeg', 'video/3gpp'] } ]
+
+
+
@@ -1,50 +0,0 @@
-Introduction
-============
-buildout recipe for collective.transcode.daemon
-
-
-Installation
-------------
-
-You can find a sample buildout here:
-https://svn.plone.org/svn/collective/collective.transcode.buildout/trunk/
-
-The transcoding scripts provided with the above buildout require ffmpeg and ffmpeg2theora.
-
-
-$ svn co https://svn.plone.org/svn/collective/collective.transcode.buildout/trunk transcode.buildout
-$ cd transcode.buildout
-$ python bootstrap.py
-$ ./bin/buildout -v
-$ ./bin/transcodedaemon fg
-Initializing
-...
-2009-11-25 19:28:14+0200 [-] Scheduler thread running
-
-
-Supported options
------------------
-
-The recipe supports the following options:
-
-listen_host
- hostname to listen
-listen_port
- port to use
-videofolder
- relative path of folder where transcoded videos are stored
-profiles
- a python list of dicts specifying the supported transcoded profiles. The dict should contain the id of the profile, the command to be executed with the first parameter to be the input and the second the output file, and the list of supported mime types for this profile
- e.g. profiles = [ {'id':'low', 'cmd':'scripts/lowQualityTranscode %s %s', 'supported_mime_types': ['video/mpeg', 'video/3gpp'] } ]
-
-
-
-Usage
------
-
-For the moment the only way to see collective.transcode.daemon in full action is to use Plumi 3.0:
- http://plone.org/products/plumi or http://svn.plone.org/svn/collective/plumi.buildout/
-
-We are now working on a generic Plone integration component for collective.transcode.daemon. Note however that there is nothing Plone specific in c.t.d. It shouldn't be hard to integrate it in any other content management framework.
-
-
View
@@ -11,12 +11,7 @@ def read(*rnames):
version = '0.2'
long_description = (
- read('collective/transcode/recipe/README.txt')
- + '\n' +
- 'Detailed Documentation\n'
- '**********************\n'
- + '\n' +
- read('collective', 'transcode', 'recipe', 'README.txt')
+ read('README.txt')
+ '\n' +
'Contributors\n'
'************\n'
@@ -31,6 +26,7 @@ def read(*rnames):
'Download\n'
'********\n'
)
+
entry_point = 'collective.transcode.recipe:Recipe'
entry_points = {"zc.buildout": ["default = %s" % entry_point]}

0 comments on commit c353e6e

Please sign in to comment.