|
From: Martin R. <ru...@us...> - 2009-03-24 18:56:28
|
Update of /cvsroot/foo/foo/elkfoo In directory fdv4jf1.ch3.sourceforge.com:/tmp/cvs-serv16467 Modified Files: README Log Message: removed doubled readme text and pointed to toplevel README file Index: README =================================================================== RCS file: /cvsroot/foo/foo/elkfoo/README,v retrieving revision 1.2 retrieving revision 1.3 diff -C2 -d -r1.2 -r1.3 *** README 15 Aug 2004 20:48:44 -0000 1.2 --- README 24 Mar 2009 18:56:16 -0000 1.3 *************** *** 4,177 **** -------------------------- ! last edited 2004-07-29 rumori ! ! this readme contains information about the requirements, installation ! and yet undocumented features of foo. ! ! ! requirements ! ------------ ! ! - libsndfile >= 1.0.10 (!) ! IMPORTANT: libsndfile prior to 1.0.10 has severe bugs in AIFF | ! FLOAT file support (which could be used for incremental mixing in ! foo) and in soundfile read/write mode, which is heavily used in foo. ! the version of libsndfile coming with your distribution might be an ! older one and therefore *TOO OLD*. ! - pkgconfig (for detection of libsndfile) ! - fooelk >= 0.0.3 or recent "ordinary" elk ! (however, toplevel.foo relies on the readline-patch in elk, ! but there is the --no-rl option now) ! - gnustep-make, gnustep-base ! ! ! installation ! ------------ ! ! compiling from cvs ! ------------------ ! ! if you checked out from cvs, call ! ! ./bootstrap ! ! you'll need autoconf >= 2.50 to build the configure script. after ! that, you can continue like compiling from a release tarball. ! ! ! compiling from release tarball ! ------------------------------ ! ! ./configure ! ! as usual, you may set the install-prefix/paths with ! ! ./configure --prefix=/usr/local/anywhere etc. ! ! configure looks for an installation of fooelk first, after that it ! tries to find an "ordinary" elk installation. if elk is not found, ! foo refuses to build. you may specify the location of elk/fooelk with ! ! ./configure --with-elk-include=/path/to/elk/headers \ ! --with-elk-library=/path/to/elk/lib ! ! make ! make install ! ! should build and install foo. depending on the target directory, you ! may have to call 'make install' as root. ! ! configure should set the install paths to toplevel.scm and to the ! binary foo, so that you should be able to run the binary 'foo' from ! everywhere. depending on your installation, you might add the path to ! libsndfile and libfooelk/libelk to LD_LIBRARY_PATH: ! ! export LD_LIBRARY_PATH=${LD_LIBRARY_PATH}:/path/to/libs ! (sh-compatible shell) ! ! ! yet undocumented (new) features ! ------------------------------- ! ! while porting and developing foo it's undergoing several changes, ! which can't be documented right now: ! ! ! new archiving functions layout (backwards compatible) ! ----------------------------------------------------- ! ! the canonical form for the archiving functions (write-context) and ! (read-context) are now: ! ! (write-context <context> [<filename|port> [<XML?>]]) ! (read-context [<filename|port>]) ! ! that way, backwards compatability is given. the last argument to ! (write-context) is a boolean specifying whether XML archive format or ! native binary format should be used. ! ! ! scripting foo via the #! directive ! ---------------------------------- ! ! *** DOCUMENT_ME *** ! ! for a simple example, see Examples/scripts/sine.foo ! ! ! user-accessible play command ! ---------------------------- ! ! the variable 'foo-default-play-command' may contain the play command ! being used with (play) along with additional initial arguments: ! ! (set! foo-default-play-command "alsaplayer -q -i text") ! ! ! customization with foo files ! ---------------------------- ! ! historically foo tries to evaluate the files '~/.initfoo' and ! './.initfoo' (in this order) on startup. these files may contain ! normal foo code to customize the behavior of foo. ! ! from foo-0.0.4 on, the following files are evaluated for ! customization: ! ! /etc/foo/init.foo (system wide settings) ! ~/.foo/init.foo (user's settings) ! ./.init.foo (working dir settings) ! ! backwards compatability to the behavior of foo-2.1 is still retained. ! it should not be used for new projects. ! ! ! start option to disable readline support ! ---------------------------------------- ! ! if foo is started with the '--no-rl'-option, a different toplevel file ! will be used which doesn't rely on fooelk's readline extension. as a ! side effect, the symbol completer is disabled, too, which avoids ! problems which sourcecode containing tabs at stdin (script or in ! emacs' inferior mode). ! ! ! fractional tone custom reader ! ----------------------------- ! ! the foo-(NeXT)-2.1-semitone reader is not longer supported. the new ! syntax for fractional tones is: ! ! #s1 ; half tone ! 1.05946309435929530984310531494 ! ! #s12 ; twelve half tones = 1 octave ! 2 ! ! #s1/2 ; half half tone = 1 quarter tone ! 1.029302236643492074463779317739 ! ! #q1 ; quarter tone ! 1.029302236643492074463779317739 ! ! ! libsndfile support (since foo-0.0.2) ! ------------------------------------ ! ! foo can read and write every sound format supported by libsndfile. in ! constrast to the foo-2.1-(NeXT)-documentation, the following ! functions/macros where adopted to reflect this feature: ! ! (make-soundfile "name" fileformat channels samplingrate . filetype) ! (create-soundfile "name" fileformat channels samplingrate . filetype) ! ! (synt channels duration samplingrate "name" fileformat filetype) ! ! where filetype is one of: ! ! 'wav 'aiff 'snd 'paf 'svx 'nist 'voc 'ircam 'wav64 'mat4 'mat5 'pvf 'xi ! note: there is no special 'au type, but 'snd is the same format (Sun/NeXT). ! the default filetype is 'aiff. --- 4,11 ---- -------------------------- ! last edited 2004-03-24 rumori ! this is elkfoo, part of the foo sound synthesis system. ! for further informations, please refer to the toplevel README file. |