update README.md
This commit is contained in:
Stéphane Lesimple
90
README.md
90
README.md
@@ -1,67 +1,53 @@
|
||||
This directory tree contains dvdisaster,
|
||||
a tool providing additional ECC protection for optical media.
|
||||
# dvdisaster provides additional ECC protection for optical media
|
||||
|
||||
It can loosely be compared to *par2* files, but the protection works at the *iso* level instead of working at the file level. This way, even if metadata from the optical media filesystem is damaged, dvdisaster can still work flawlessly.
|
||||
|
||||
This version of dvdisaster supports the following platforms:
|
||||
Linux, FreeBSD, NetBSD on x86, PowerPC, and Sparc.
|
||||
Linux, FreeBSD, NetBSD on x86, PowerPC, Sparc, and Windows.
|
||||
|
||||
Three protection codecs are supported, they're quickly detailed below. Please see the documentation/manual.pdf for more information about these, and everything else.
|
||||
|
||||
Roadmap of contained files
|
||||
--------------------------
|
||||
# The codecs
|
||||
|
||||
INSTALL
|
||||
See the file INSTALL on bringing up dvdisaster.
|
||||
## RS01
|
||||
|
||||
README.CVS
|
||||
If you got this archive from CVS, make sure to read README.CVS also.
|
||||
RS01 creates error correction files which are stored separately from the image they
|
||||
belong to. The artefact is an **ecc** file, which must be stored on another media than the one we're protecting.
|
||||
|
||||
README.MODIFYING
|
||||
Please read these notes carefully if you plan to modify dvdisaster.
|
||||
## RS02
|
||||
|
||||
COPYING
|
||||
This software is distributed under the GNU General Public License,
|
||||
which is contained in the file COPYING.
|
||||
RS02 creates error correction data which is added to the medium to protect, we call this *augmenting* the image we're protecting. Damaged sectors in the error correction information reduce the data recovering capacity, but do not make recovery impossible - a second medium for keeping or protecting the error correction
|
||||
information is not required.
|
||||
|
||||
CHANGELOG
|
||||
See CHANGELOG for a description of recent changes in this software.
|
||||
## RS03
|
||||
|
||||
CREDITS.*
|
||||
Even a relatively small project like dvdisaster could not come to life
|
||||
without the help of other people. See the files CREDITS.* for details.
|
||||
RS03 is a further development of RS01 and RS02. It can create both error correction files and
|
||||
augmented images, with the following added features:
|
||||
|
||||
TODO
|
||||
Some open tasks and notes about future work are contained in TODO.
|
||||
- RS03 can distribute work over multiple processor cores and is therefore much faster than
|
||||
RS01/RS02 on modern hardware.
|
||||
- RS03 error correction files are - contrary to RS01 - robust against damage. This should
|
||||
not delude you into careless handling of your error correction files though - the disadvan-
|
||||
tages of reading at the filesystem level are still valid.
|
||||
- RS03 augmented images do not require so-called master blocks holding important in-
|
||||
formation. This makes RS03 a bit more robust, but also more restrictive: The augmented
|
||||
image must completely fill the medium now while the size of augmented images can be
|
||||
freely chosen in RS02.
|
||||
The changes for parallel computation and higher robustness make RS03 a bit less space efficient,
|
||||
e.g. RS03 error correction data has slighly less error correction capacity than its RS01/RS02
|
||||
counterparts on images with equal size.
|
||||
|
||||
TRANSLATION.HOWTO
|
||||
See TRANSLATION.HOWTO if you want to help translating dvdisaster
|
||||
into your native language.
|
||||
# Unofficial version
|
||||
|
||||
md5.*
|
||||
The md5.* files come from the 2.4.20 Linux kernel distribution and
|
||||
have been adapted to the needed functionality for this project.
|
||||
See the notes in md5.c for more information.
|
||||
The last upstream version is dated 2017, and the official website is down.
|
||||
The original README has been left untouched in this repository.
|
||||
This version is built on top of the latest upstream version, with the following notable enhancements:
|
||||
|
||||
There are other files contained in the top-level directory whose
|
||||
use is limited to the build process.
|
||||
- Most Debian patches have been applied (The Debian version source code can be found [here](https://sources.debian.org/src/dvdisaster/))
|
||||
- Windows build added back (was dropped upstream a few versions before the last one)
|
||||
- A Linux CLI-only version can now be compiled, without depending on gtk
|
||||
- Regression tests confirmed working on Linux64 (normal and CLI-only), Windows32 and Windows64
|
||||
- Added pre-defined sizes for BD-R Triple Layer (100GB), BD-R Quadruple Layer (128GB)
|
||||
|
||||
|
||||
Roadmap of contained subdirectories
|
||||
-----------------------------------
|
||||
|
||||
contrib
|
||||
A few skeleton files for desktop integration and package maintenance
|
||||
are contained in the directory "contrib".
|
||||
|
||||
documentation
|
||||
The directory "documentation" contains a copy of the project
|
||||
home page, which doubles as user manual and project documentation.
|
||||
|
||||
icons
|
||||
Icons used in the graphical interface are located in the respective
|
||||
directory.
|
||||
|
||||
locale
|
||||
Translations of the programs on-screen texts are in "locale".
|
||||
|
||||
scripts
|
||||
Scripts needed for configuring and building dvdisaster are
|
||||
located in the "scripts" directory.
|
||||
# Screenshots
|
||||
(todo)
|
||||
|
||||
Reference in New Issue
Block a user