README: convert to markdown

README.md

@@ -17,33 +17,33 @@ Copyright/left: 2012-2013,2015,2025 Vincent Riquer - GPLv3 (see doc/GPL-3)
 ### Optional:
 * vorbis-tools
   http://www.vorbis.com/
-    * ogginfo (Ogg Vorbis metadata)
+    * `ogginfo` (Ogg Vorbis metadata)
-    * oggenc (Ogg Vorbis encoding)
+    * `oggenc` (Ogg Vorbis encoding)
 * opus-tools
   http://opus-codec.org/
-    * opusinfo (Opus metadata)
+    * `opusinfo` (Opus metadata)
-    * opusenc (Opus encoding)
+    * `opusenc` (Opus encoding)
-    * opusdec (Opus decoding)
+    * `opusdec` (Opus decoding)
 * LAME MP3 Encoder
   http://lame.sourceforge.net/
-    * lame (MP3 encoding)
+    * `lame` (MP3 encoding)
 * FLAC
   http://flac.sourceforge.net/
-    * metaflac (FLAC metadata)
+    * `metaflac` (FLAC metadata)
 * Musepack
   http://www.musepack.net/
-    * mpcdec (Musepack decoding)
+    * `mpcdec` (Musepack decoding)
 * FFmpeg
   http://ffmpeg.org/
-    * ffprobe (ID3v2, Musepack, Windows Media and video metadata)
+    * `ffprobe` (ID3v2, Musepack, Windows Media and video metadata)
-    * ffmpeg (Windows Media and video decoding)
+    * `ffmpeg` (Windows Media and video decoding)
 
 ## Using the software
 
 ### Configuration:
 On first run, AtOM will ask a set of questions to help you create a
 configuration file.
-You can run atom -S at any time to re-run the setup. It will be prefilled with
+You can run `atom -S` at any time to re-run the setup. It will be prefilled with
 your current configuration.
 
 If, however, you still want to make changes manually, please read doc/config.
@@ -58,7 +58,9 @@ IO required.
 
 ### Running:
 Make sure your configuration is correct by running 
+```
 $ atom -C
+```
 This will produce a human-readable dump of your current configuration.
 If all settings are correct, simply run atom with no argument. Go get a beer.
 Meet some friends. Go to bed. Depending on the size of your collection, the
@@ -68,17 +70,21 @@ much faster this time, as only changed data will be treated.
 
 If, for whatever reason, you need to force the regeneration of a destination,
 after changing the quality settings for example, run
+```
 $ atom -F <destination name>
+```
 
 ### Running as a cronjob:
-If you want to run AtOM as a cronjob, atom -q will give you a cleaner output,
+If you want to run AtOM as a cronjob, `atom -q` will give you a cleaner output,
 more suitable for mail or logfile output. You may also want to limit the size of
-each batch with -B <batch size>. AtOM will not create or update more than
+each batch with `-B <batch size>`. AtOM will not create or update more than
-<batch size> destination files.
+`<batch size>` destination files.
 
 For example:
+```
 #m  h  dom mon dow  command
 0   5   *   *   *   atom -B 1000 -q
+```
 
 ## Technical details
 ### I. Source scan
@@ -102,7 +108,7 @@ AtOM then tries to read metadata from each new or changed file. It also re-reads
 metadata from files scanned with an older version of AtOM, if the parser for
 that format has changed. The actual data read depends on the format, but at the
 very least, AtOM should identify the sampling rate, bitrate and number of
-channels. Unknown file types are scanned with ffprobe, so you may still have
+channels. Unknown file types are scanned with `ffprobe`, so you may still have
 some luck, depending on your FFmpeg setup.
 
 ### IV. Task creation
@@ -127,16 +133,10 @@ resampling/normalization is required) tasks.
 ### V. Running tasks
 
 #### V.1 Running tasks
-While running tasks, AtOM responds to the following keypresses:
-+/-     Increase/decrease max-load
-q       Quit (will skip all following steps)
-
 Progress display:
-L:<current load>/<max-load>
+```
-W:<active workers>/<concurrency>
+L:<current load>/<max-load> W:<active workers>/<concurrency> T:<last task>/<task count> (F:<failed tasks>) <pct>% <remaining time> (A:<average task duration>s/task) ETA:<estimated time of arrival>
-T:<last task>/<task count> (F:<failed tasks>)
+```
-<pct>% <remaining time> (A:<average task duration>s/task)
-ETA:<estimated time of arrival>
 
 #### V.2 Renaming files
 If rename pattern (or FAT32 compatibility) for one or more destinations has
@@ -160,13 +160,13 @@ that stage.
 AtOM requires a database to function. Now that we have a database containing
 various information about our media files, why not use it?
 AtOM comes with a small set of tools in the toys/ directory. These are
-documented in toys/README.
+documented in `toys/README`.
 
 # Shameless Self Promotion
 I am the author of free (Creative Commons CC-By-SA) music which you can stream
-for free, or buy to get high quality and bonuses from Bandcamp
+for free, or buy to get high quality and bonuses from
-(http://djblackred.bandcamp.com). If you like electronic music taking its
+[Bandcamp](http://djblackred.bandcamp.com). If you like electronic music taking
-inspiration from Trance, Drum & Bass, Ambient and (rarely) Free Jazz, please
+its inspiration from Trance, Drum & Bass, Ambient and (rarely) Free Jazz, please
 check it out!
 Downloads are available in FLAC, Ogg, MP3, and more, and includes the "source
 code" (sequencer files and the likes) for most tracks.