From: Bastian Dehn <hhaalo@arcor.de>
Date: Fri, 4 Feb 2022 19:37:23 +0000 (+0100)
Subject: add: readme file
X-Git-Url: https://gitweb.hhaalo.de/?a=commitdiff_plain;h=0142cbb26ea667587db70c527e8ff5c1b87b14a4;p=discspan-java.git

add: readme file
---

diff --git a/readme.md b/readme.md
new file mode 100644
index 0000000..c347838
--- /dev/null
+++ b/readme.md
@@ -0,0 +1,37 @@
+# discspan
+
+## Description
+
+Discspan split a text file with data source pathes. Each output file contains  
+the pathes on one media. The output file is calculate best use space on media.  
+Files to big for a media is in output file with number zero.
+
+## Installation
+
+```bash
+mkdir build
+cd build
+
+cmake ..
+
+make
+```
+
+## Example to use
+
+```bash
+# 1. Create a data file list:
+find /pfad/zur/den/Dateien -type f > testfile
+
+# 2. Execute discspan to split files on single layer DVD
+java -jar discspan.jar -i testfile -o medium -5
+
+# 3. Copy files from text file into seperated folder
+rsync -av --files-from=medium / /pfad/zum/wegkopieren/
+# or
+cat medium | xargs -i cp -rl --parents {} /pfad/zum/wegkopieren
+```
+
+## Licence
+
+[MIT License](license)