quickstart-guide.dpatch

darcs-hash:20070304124948-c06f4-91b07cd70dad8322b75398c8b359d739f5000327.gz

1 files changed, 70 insertions, 1 deletions

diff --git a/emms.texinfo b/emms.texinfo
index 1b00957..0ea97fb 100644
--- a/emms.texinfo
+++ b/emms.texinfo
@@ -52,6 +52,7 @@ Starting out
 * Installation::        How to install Emms on your System.
 * Simple Setup::        Quick, basic default Emms setup.
 * Configuration::       More detailed setup and configuration.
+* Quickstart Guide::    First steps with EMMS for new users.
 
 Emms basics
 * Basic Commands::      How to control Emms with ease.
@@ -106,7 +107,7 @@ The Core File
 Track Information
 * Defining Info Methods::    Defining new info methods.
 
-Volume
+Last.fm
 * Submitting track informations:: How to submit track information to last.fm.
 * Last.fm radio::                 How to listen to last.fm radio.
 
@@ -335,6 +336,74 @@ have GNU/find installed.
 The method Emms will use is defined in the customisable variable
 @var{emms-source-file-directory-tree-function}.
 
+@node Quickstart Guide
+@chapter Quickstart Guide
+
+This chapter demonstrates how to setup EMMS so that you can start
+listening to your music without having to read the whole docs first. 
+
+The first thing you have to do is telling emacs where the sources of
+EMMS are located. Let's say you have them in @file{~/elisp/emms/}. So
+add this line to your @file{.emacs}.
+
+@lisp
+(add-to-list 'load-path "~/elisp/emms")
+@end lisp
+
+Further informations about installing EMMS can be found in the
+installation chapter, @xref{Installation}.
+
+Let's say you want to enable all features which are considered stable by
+the EMMS developers. To achieve this you invoke the @code{emms-all}
+setup function by adding those three lines to your @file{.emacs}.
+
+@lisp
+(require 'emms-setup)
+(emms-all)
+(emms-default-players)
+@end lisp
+
+The function @code{emms-default-players} in the last line sets up the
+list of default players. The list contains lightweight specialized
+players like ogg123 or mpg321 and we-play-everything-players like
+mplayer or xine. To be sure that emms can play all your music you should
+check that the needed players are installed.
+
+Further informations about the several setup scripts can be found in the
+simple setup chapter, @xref{Simple Setup}.
+
+Of course EMMS tries to display the tags of the music files you listen
+to. For this to work you have to make sure that the appropriate programs
+are installed. For mp3 files you need `mp3info', for ogg files you need
+`ogginfo'.
+
+The last thing to do is to tell EMMS the root directory of our music
+collection. Let's say all your music is in @file{~/Music} or in
+subdirectories thereof.
+
+@lisp
+(setq emms-source-file-default-directory "~/Music/")
+@end lisp
+
+Ok, now we've set up EMMS. Reload your @file{.emacs} or restart Emacs to
+let the changes have an effect.
+
+Now we will add all our music to a playlist by invoking @kbd{M-x
+emms-add-directory-tree RET ~/Music/ RET}. We do this because then EMMS
+will read the tags of all your music files and cache them. This is
+required for the browser, @xref{The Browser}.
+
+To switch to the playlist buffer invoke @kbd{M-x
+emms-playlist-mode-go}. You can see that most tracks are displayed with
+their file name, but track by track the filename gets replaced with the
+artist and track name of the file's tag.
+
+Hit @kbd{RET} on a track to start playback.
+
+Now you can start exploring EMMS. It's probably best to begin with the
+basic commands (@pxref{Basic Commands}), the interactive playlists
+(@pxref{Interactive Playlists}), and the browser (@pxref{The Browser}).
+
 @node Basic Commands
 @chapter Basic Commands