Update 'README.md'

README.md

@@ -1,12 +1,33 @@
-morituri is a CD ripper aiming for accuracy over speed for UNIX systems.
+FORK INFORMATIONS
-Its features are modeled to compare with Exact Audio Copy on Windows.
+---------
-The home page is https://thomas.apestaart.org/morituri/trac/
+The name of this fork is still to be decided, right now I'll be using whipper.
 
+This branch is very close to morituri's master one (the internal 'morituri' references are still unchanged), I've just merged the following commits:
+- [#79](https://github.com/thomasvs/morituri/issues/79)
+- [#92](https://github.com/thomasvs/morituri/issues/92)
+- [#109](https://github.com/thomasvs/morituri/issues/109)
+- [#133](https://github.com/thomasvs/morituri/issues/133) (with custom `.travis.yml`)
+- [#137](https://github.com/thomasvs/morituri/issues/137)
+- [#139](https://github.com/thomasvs/morituri/issues/139)
+- [#140](https://github.com/thomasvs/morituri/issues/140)
+- [#141](https://github.com/thomasvs/morituri/issues/141)
+
+And changed the default logger to the morituri-whatlogger's one.
+
+WHIPPER [![Build Status](https://travis-ci.org/JoeLametta/morituri.svg?branch=fork)](https://travis-ci.org/JoeLametta/morituri)
+---------
+whipper is a fork of the morituri project (CDDA ripper, for *nix systems, aiming for accuracy over speed).
+
+It improves morituri which development seems to have halted/slowed down merging old pull requests and improving it with new functions.
+
+If possible, I'll try to mainline the useful commits of this fork but, in the future, this may not be possible because of different project choices.
+
+The home page is still TBD.
 
 RATIONALE
 ---------
-For a more detailed rationale, see my wiki page ['The Art of the Rip'](
+For a more detailed rationale, see morituri's wiki page ['The Art of the Rip'](
-https://thomas.apestaart.org/thomas/trac/wiki/DAD/Rip).
+http://thomas.apestaart.org/thomas/trac/wiki/DAD/Rip).
 
 FEATURES
 --------
@@ -14,7 +35,7 @@ FEATURES
 * support for AccurateRip (V1) verification
 * detects sample read offset and ability to defeat cache of drives
 * performs test and copy rip
-* detects and rips Hidden Track One Audio
+* detects and rips Hidden Track One Audio (only if not digitally silent)
 * templates for file and directory naming
 * support for lossless encoding and lossy encoding or re-encoding of images
 * tagging using GStreamer, including embedding MusicBrainz id's
@@ -27,29 +48,30 @@ REQUIREMENTS
 - cdparanoia, for the actual ripping
 - cdrdao, for session, TOC, pregap, and ISRC extraction
 - GStreamer and its python bindings, for encoding
-  - gst-plugins-base >= 0.10.22 for appsink
+  - gstreamer0.10-base-plugins >= 0.10.22 for appsink
+  - gstreamer0.10-good-plugins for wav encoding (it depends on the Linux distro used)
 - python musicbrainz2, for metadata lookup
 - python-setuptools, for plugin support
-- python-cddb, for showing but not using disc info if not in musicbrainz
+- python-cddb, for showing but not using disc info if not in MusicBrainz
 - pycdio, for drive identification (optional)
-  - Required for drive offset and caching behaviour to be stored in the config file
+  - Required for drive offset and caching behavior to be stored in the config file
 
 Additionally, if you're building from a git checkout:
 - autoconf
 - automake
 
-GETTING MORITURI
+GETTING WHIPPER
 ----------------
 If you are building from a source tarball or checkout, you can choose to
-use morituri installed or uninstalled.
+use whipper installed or uninstalled.
 
 - getting:
-    - Change to a directory where you want to put the morituri source code
+    - Change to a directory where you want to put the whipper source code
       (For example, `$HOME/dev/ext` or `$HOME/prefix/src`)
     - source: download tarball, unpack, and change to its directory
     - checkout:
 
-            git clone git://github.com/thomasvs/morituri.git
+            git clone -b fork --single-branch git://github.com/JoeLametta/morituri.git
             cd morituri
             git submodule init
             git submodule update
@@ -69,11 +91,11 @@ use morituri installed or uninstalled.
     - running uninstalled:
 
             ln -sf `pwd`/misc/morituri-uninstalled $HOME/bin/morituri-git
-            morituri-git  # this drops you in a shell where everything is set up to use morituri
+            morituri-git  # this drops you in a shell where everything is set up to use whipper
 
-RUNNING MORITURI
+RUNNING WHIPPER
 ----------------
-morituri currently only has a command-line interface called 'rip'
+whipper currently only has a command-line interface called 'rip'
 
 rip is self-documenting.
 `rip -h` gives you the basic instructions.
@@ -96,8 +118,7 @@ Check the man page (rip(1)) for more information.
 
 RUNNING UNINSTALLED
 -------------------
-
+To make it easier for developers, you can run whipper straight from the
-To make it easier for developers, you can run morituri straight from the
 source checkout:
 
     ./autogen.sh
@@ -127,8 +148,10 @@ The simplest way to get started making accurate rips is:
 
 FILING BUGS
 -----------
-morituri's bug tracker is at [https://thomas.apestaart.org/morituri/trac/](
+whipper's bug tracker is still TBD.
-https://thomas.apestaart.org/morituri/trac/).
+
+morituri's bug tracker is at [http://thomas.apestaart.org/morituri/trac/](
+http://thomas.apestaart.org/morituri/trac/).
 When filing bugs, please run the failing command with the environment variable
 `RIP_DEBUG` set; for example:
 
@@ -141,10 +164,10 @@ KNOWN ISSUES
 ------------
 - no GUI yet
 - only AccurateRip V1 CRCs are computed and checked against the online database
-- `rip offset find` fails to delete the temporary .wav files it creates if error occurs while ripping (thomasvs/morituri#75)
+- `rip offset find` fails to delete the temporary .wav files it creates if an error occurs while ripping
 - morituri detects the pre-emphasis flag in the TOC but doesn't add it to the cue sheet
-  - To improve the accuracy of the detection the sub-channel data should be scanned too
+  - To improve the accuracy of the detection, the sub-channel data should be scanned too
-- CD-Text is not used when ripping CDs not available in MusicBrainz DB
+- cd-text isn't read from the CD (useful when the CD informations are not available in the MusicBrainz DB)
 
 GOALS
 -----
@@ -155,7 +178,6 @@ GOALS
 
 CONFIGURATION FILE
 ------------------
-
 The configuration file is stored according to [XDG Base Directory Specification](
 http://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html)
 when possible.
@@ -192,7 +214,4 @@ Note: to get a literal '%' character it must be doubled.
 
 CONTRIBUTING
 ------------
-- Please send pull requests through github.
+- Please send pull requests through GitHub.
-- You can always [flattr morituri to donate](https://flattr.com/submit/auto?%20%20user_id=thomasvs&url=https://thomas.apestaart.org/morituri/trac/&%20%20title=morituri&%20%20description=morituri&%20%20language=en_GB&tags=flattr,morituri,software&category=software)
-
-