[sound-juicer/wip/hadess/remove-autotools] README: Rename to README.md



commit 05b1be0f51c2ab8b2a764f17728c5a5f2aa24467
Author: Bastien Nocera <hadess hadess net>
Date:   Tue Feb 25 09:41:02 2020 +0100

    README: Rename to README.md
    
    And update style.

 README => README.md | 19 +++++++++----------
 meson.build         |  2 +-
 2 files changed, 10 insertions(+), 11 deletions(-)
---
diff --git a/README b/README.md
similarity index 70%
rename from README
rename to README.md
index 0286e8a4..d09a9611 100644
--- a/README
+++ b/README.md
@@ -1,4 +1,5 @@
-Sound Juicer
+# Sound Juicer
+
 Copyright (C) 2003-6 Ross Burton
 
 Licensed under the GPL, version 2 or greater.
@@ -7,34 +8,32 @@ Licensed under the GPL, version 2 or greater.
 This is Sound Juicer, a CD ripping tool using GTK+ and GStreamer.
 
 Requirements:
-* GNOME 2.26 Platform (gconf, libbrasero-media, gnome-media-profiles)
-* GStreamer 1.0 (or 0.11 pre-releases) and above
 
-Do the usual configure/make/make install malarky, and run "sound-juicer" in
-$(prefix)/bin or "Sound Juicer CD Extractor" in Applications -> Sound & Video.
+- GNOME 3.22 Platform (GTK, libbrasero-media, gnome-media-profiles, etc.)
+- GStreamer 1.0 and above
 
-If the CD lookup is returning weird data, export G_MESSAGES_DEBUG=sj-metadata
+If the CD lookup is returning weird data, export `G_MESSAGES_DEBUG=sj-metadata`
 before running sound-juicer to turn metadata debugging messages.
 
 
 Common Problems
 ===============
 
-"Sound Juicer can't see my CD drive!"
+### "Sound Juicer can't see my CD drive!"
 
 Sound Juicer queries the kernel for CD drives, so you don't need to know the
 device name.  For this to work you'll need some kernel modules loaded: either
 ide-cd (for IDE drives) or sg (for SCSI drives).
 
 
-"Sound Juicer doesn't start, it can't find a plugin to access the CD drive!"
+### "Sound Juicer doesn't start, it can't find a plugin to access the CD drive!"
 
 You need the GStreamer cdparanoia plugin.  Most distributions should ship this
 with GStreamer, if you built it youself check you have the cdparanoia headers
 installed.
 
 
-"I cannot encode to MP3!"
+### "I cannot encode to MP3!"
 
 To encode to MP3 you need the GStreamer Lame plugin.  Most distributions don't
 ship this due to patents and licence fees, so you will have to build lame
@@ -42,7 +41,7 @@ yourself, and then rebuild gstreamer-plugins.  Details of the pipeline
 required is in the documentation.
 
 
-"It won't rip my CD!"
+### "It won't rip my CD!"
 
 Try ripping the cd with cdparanoia, cdda2wav, grip, or any other CD ripper.  If
 these work it is possible to rip the CD so file a bug with Sound Juicer.  If
diff --git a/meson.build b/meson.build
index cbc68e40..4188297a 100644
--- a/meson.build
+++ b/meson.build
@@ -76,7 +76,7 @@ configure_file(
 doc_data = files(
   'COPYING',
   'NEWS',
-  'README',
+  'README.md',
   'AUTHORS'
 )
 


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]