ref: 83a3a0a316e27909c6f31655bc7c8c8a2585e2b1
parent: b6faa22c951f34b6b1c3d983b475c183069cf2ed
author: cbagwell <cbagwell>
date: Mon Sep 13 20:34:06 EDT 2004
doc updates
--- a/INSTALL
+++ b/INSTALL
@@ -3,8 +3,7 @@
This distribution will compile and run on most UNIX systems.
It was originally developed on a UNIX/386 machine running AT&T V.3.2
but its currently developed under Linux. With little work it should
-work with most SVR4 systems, BSD-derived UNIX's and DOS/Windows systems
-that use the GNU tool set.
+work with most UNIX-like systems.
Compiling
---------
@@ -11,16 +10,15 @@
The preferred method for compiling SoX is to use the "configure" scripts
compatible with most UNIX systems that contain "/bin/sh" or equivalent
-(even the Win95/NT Cygwin setup will work with this).
+(even the Window's Cygwin setup will work with this).
-To compile SoX on these platforms run the following commands:
+To compile and install SoX on these platforms run the following commands:
./configure
make
make install
-You should then have a working version of SoX in the directory. There
-are several optional parameters that you may pass to the configure
+There are several optional parameters that you may pass to the configure
script to customize SoX for your applications. Run "./configure --help"
for a complete list of options.
@@ -28,8 +26,8 @@
to the Optional Compiling section.
If your system does not work with the configure scripts then there are
-several canned "Makefile"'s that you can use. The following systems
-have a canned Makefile:
+several canned "Makefile"'s that you can use inside the src directory.
+The following systems have a canned Makefile:
DOS Makefile.dos (Borland or Turbo C)
WIN95/NT Makefile.dos (Needs modifying for Visual C++)
@@ -37,11 +35,14 @@
To use a canned Makefile, a few steps need to be completed. First up,
you need to make a copy of stconfig.h.in and call it stconfig.h. Modify
-this file to reflect your environment.
+this file to reflect your environment.
+FIXME: A file called ststdint.h needs to be created as well. This
+is the same as stdint.h if your system has it.
+
After that, copy either Makefile.dos or Makefile.gcc to a file
-called Makefile. This needs to be done in both the main SoX directory
-and the ./gsm directory. This file also needs to be modified to reflect
+called Makefile. This needs to be done in both the src directory
+and the src/gsm directory. This file also needs to be modified to reflect
your environment.
Optional Compile Features
@@ -70,15 +71,16 @@
After successfully compiling SoX, try translating a sound file.
If you can play one of the supported sound file formats,
-translate 'monkey.voc' to your format (we'll use 'xxx'):
+translate 'monkey.wav' to your format (we'll use 'xxx'):
- sox monkey.voc monkey.xxx
+ cd src
+ ./sox monkey.wav monkey.xxx
You may have to give the word size and rate for the file.
For example, this command will make a sound file with a data rate of
12,500 samples per second and the data formatted as signed shorts:
- sox monkey.voc -r 12500 -s -w monkey.xxx
+ ./sox monkey.voc -r 12500 -s -w monkey.xxx
If monkey.xxx plays properly (it's a very short monkey screech),
congratulations! SoX works.