aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDaniil Cherednik <dan.cherednik@gmail.com>2016-12-08 01:56:59 +0300
committerDaniil Cherednik <dan.cherednik@gmail.com>2016-12-08 01:56:59 +0300
commiteb1c592ec203cb55362f75bf023bd70f4f524601 (patch)
tree9f35eb343ddf350ba050a627d72382aed54f513b
parent00a040eee75ef0076180958ed736e3dfe171b49e (diff)
downloadatracdenc-eb1c592ec203cb55362f75bf023bd70f4f524601.tar.gz
README.md updated
-rw-r--r--README.md38
1 files changed, 26 insertions, 12 deletions
diff --git a/README.md b/README.md
index 5daf615..9aae2d0 100644
--- a/README.md
+++ b/README.md
@@ -1,27 +1,41 @@
# atracdenc - ATRAC Decoder Encoder
-Implementation of ATRAC1 encoder
+Implementation of ATRAC1, ATRAC3 encoders
Building:
-You need C++11 compiler.
-cmake > 2.8
-libsndfiles
+
+You need:
+* C++11 compiler.
+* cmake > 2.8
+* libsndfiles
binary:
-`cd src`
-`mkdir build`
-`cd build`
-`cmake ../`
-`make`
+```
+cd src
+mkdir build
+cd build
+cmake ../
+make
+```
binary and tests:
-`cd test`
-`cmake ../`
-`make`
+```
+cd test
+cmake ../
+make
+```
Usage:
+
+ATRAC1:
+```
+./atracdenc --encode -i ~/01.wav -o /tmp/01.aea
+```
+
+ATRAC3: - use it only if you want to improve it ;)
+
You can use --help option to get help
Limitations: