changeset 11230:d0d12e495f89 octave-forge

video: remove stuff in DESCRIPTION from README and move README to doc
author carandraug
date Fri, 09 Nov 2012 14:26:44 +0000
parents 033ebb2a1183
children 6eff9955e763
files main/video/DESCRIPTION main/video/README main/video/doc/README
diffstat 3 files changed, 33 insertions(+), 60 deletions(-) [+]
line wrap: on
line diff
--- a/main/video/DESCRIPTION	Fri Nov 09 14:13:08 2012 +0000
+++ b/main/video/DESCRIPTION	Fri Nov 09 14:26:44 2012 +0000
@@ -4,8 +4,10 @@
 Author: Stefan van der Walt <stefan@sun.ac.za> and Roman Stanchak
 Maintainer: Octave-Forge community <octave-dev@lists.sourceforge.net>
 Title: Video functions
-Description: Implements addframe, avifile, aviinfo, and aviread, using ffmpeg. (and approximately conforms to Matlab interface)
+Description: A wrapper for ffmpeg's libavformat and libavcodec, implementing
+ addframe, avifile, aviinfo, and aviread.
 Depends: octave (>= 2.9.12)
 SystemRequirements: >=ffmpeg-0.7
 License: FreeBSD
 Url: http://octave.sf.net
+Url: http://mentat.za.net
--- a/main/video/README	Fri Nov 09 14:13:08 2012 +0000
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,59 +0,0 @@
-Octave-Avifile
-==============
-
-Description
------------
-A wrapper for ffmpeg's libavformat and libavcodec, allowing Octave to read
-and write fixed-framerate AVI (Audio/Video Interleaved) files.
-	     
-Author
-------
-Stefan van der Walt <stefan@sun.ac.za>
-http://mentat.za.net
-
-Contributors
-------------
-Roman Stanchak
-Xavier Delacour
-
-Dependencies
-------------
-This package _should_ always work with the latest version of ffmpeg. It is
-known to at least work with ffmpeg SVN revision 15410.
-
-You can download ffmpeg from
-http://ffmpeg.mplayerhq.hu
-
-Note that you'll need to configure it with --enable-swscale and --enable-gpl,
-to enable the software scaler library (used for yuv/rgb conversions).
-
-Compiling
----------
-$ ./configure
-$ make
-
-The commands `avifile' and `addframe' should then be available in Octave.
-
-Usage Notes
------------
-- If ffmpeg complains about "too many threads", increase the frame height
-  and width.  For some obscure reason, they do a comparison between the number
-  of threads and the frame dimensions.
-  
-- Remember to `clear' a movie after adding the last frame.  This gives
-  `avifile' a chance to write some headers and close the file, i.e.
-  
-  octave:1> x = avifile("test.avi", "msmpeg4v2");
-  octave:2> addframe(x, zeros(100,100));
-  octave:3> clear x
-
-- If `aviinfo' crashes, you might have run into a libstdc++ memory allocation
-  bug.  Work around the problem by executing
-  
-  $ export GLIBCXX_FORCE_NEW=1
-  
-  before running Octave.
-
-Licence
--------
-See the file `COPYING'.
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/main/video/doc/README	Fri Nov 09 14:26:44 2012 +0000
@@ -0,0 +1,30 @@
+Dependencies
+------------
+This package _should_ always work with the latest version of ffmpeg. It is
+known to at least work with ffmpeg SVN revision 15410.
+
+You can download ffmpeg from
+http://ffmpeg.mplayerhq.hu
+
+Note that you'll need to configure it with --enable-swscale and --enable-gpl,
+to enable the software scaler library (used for yuv/rgb conversions).
+
+Usage Notes
+-----------
+- If ffmpeg complains about "too many threads", increase the frame height
+  and width.  For some obscure reason, they do a comparison between the number
+  of threads and the frame dimensions.
+  
+- Remember to `clear' a movie after adding the last frame.  This gives
+  `avifile' a chance to write some headers and close the file, i.e.
+  
+  octave:1> x = avifile("test.avi", "msmpeg4v2");
+  octave:2> addframe(x, zeros(100,100));
+  octave:3> clear x
+
+- If `aviinfo' crashes, you might have run into a libstdc++ memory allocation
+  bug.  Work around the problem by executing
+  
+  $ export GLIBCXX_FORCE_NEW=1
+  
+  before running Octave.