about summary refs log tree commit homepage
path: root/INSTALL
diff options
context:
space:
mode:
authorEric Wong <normalperson@yhbt.net>2013-08-25 00:58:14 +0000
committerEric Wong <normalperson@yhbt.net>2013-08-25 02:10:32 +0000
commit6c2ec9e4bd3c55221c05ba8b0f9f0cad782fbcc3 (patch)
tree0212b14f5fef3becdea65729f0167f5f36d0e842 /INSTALL
parent78e9feabf8030bbf37f36977c3f6ebca78260b20 (diff)
downloaddtas-6c2ec9e4bd3c55221c05ba8b0f9f0cad782fbcc3.tar.gz
Rename COPYRIGHT -> COPYING, as that seems to be the more common
name for the GPLv3 license file.  Kill all rdoc, since I don't
agree with HTML documentation and we do not expose any Ruby APIs.
Diffstat (limited to 'INSTALL')
-rw-r--r--INSTALL40
1 files changed, 32 insertions, 8 deletions
diff --git a/INSTALL b/INSTALL
index 433e2b6..c374053 100644
--- a/INSTALL
+++ b/INSTALL
@@ -1,15 +1,17 @@
 Uncommon for audio software, dtas is implemented in Ruby.
 
 The latest stable release of Ruby is recommended, currently 2.0.0-p247.
-We are currently NOT compatible with Ruby 1.9.3, but we may support it
-if there is demand.
+However, Ruby 1.9.3 should work, too.  Older versions of Ruby are not
+recommended.
 
-SoX is a dependency of dtas.  While not _strictly_ required, the
+SoX is a dependency of dtas-player.  While not _strictly_ required, the
 dtas-player uses SoX by default and you will need it unless you've
-reconfigured dtas to use something else.
+reconfigured dtas-player to use something else.
 
-mp3gain is required if you use ReplayGain with MP3s, and metaflac is
-required for dtas-cueedit (and possibly future scripts).
+mp3gain is required if you use ReplayGain with MP3s
+
+If you only intend to use dtas-cueedit, you will need metaflac(1) from
+the FLAC package.
 
 Debian users can install sox, mp3gain, and flac dependencies easily:
 
@@ -22,8 +24,30 @@ Debian users can install sox, mp3gain, and flac dependencies easily:
   speedups.  If you cannot be bothered to have a development
   environment, just use "gem install dtas"
 
-  gem install dtas-linux
+    gem install dtas-linux
+
+  This should pull in the "io_splice" and "sleepy_penguin" RubyGems
+
+  For future upgrades of dtas (upgrades to dtas-linux will be infrequent)
 
-= installing dtas RubyGem on non-GNU/Linux or old GNU/Linux systems
+    gem update dtas
+
+= installing the dtas RubyGem on non-GNU/Linux or old GNU/Linux systems
 
   gem install dtas
+
+= installing dtas via tarball and setup.rb
+
+  Grab the latest tarball from our HTTP site:
+
+  http://dtas.80x24.org/2013/dtas-0.0.0.tar.gz
+
+  $ tar zxvf dtas-0.0.0.tar.gz
+  $ cd dtas-0.0.0
+  $ ruby setup.rb
+
+  GNU/Linux users may optionally install "io_splice" and
+  "sleepy_penguin" packages:
+
+  io_splice - http://bogomips.org/ruby_io_splice/
+  sleepy_penguin - http://bogomips.org/sleepy_penguin/