README

   1
   2                      cmus - C* Music Player
   3
   4                     http://cmus.sourceforge.net/
   5
   6          Copyright 2004-2008 Timo Hirvonen <tihirvon@gmail.com>
   7
   8
   9 Configuration
  10 -------------
  11
  12 List available optional features
  13
  14   $ ./configure --help
  15
  16 Auto-detect everything
  17
  18   $ ./configure
  19
  20 To disable some feature, arts for example, and install to $HOME run
  21
  22   $ ./configure prefix=$HOME CONFIG_ARTS=n
  23
  24 After running configure you can see from the generated config.mk file
  25 what features have been configured in (see the CONFIG_* options).
  26
  27 NOTE: For some distributions you need to install development versions
  28 of the dependencies.  For example if you want to use 'mad' input plugin
  29 (mp3) you need to install libmad0-dev (Debian) or libmad-devel (RPM)
  30 package. After installing dependencies you need to run ./configure
  31 again, of course.
  32
  33 If you want to use the Tremor library as alternative for decoding
  34 Ogg/Vorbis files you have to pass CONFIG_TREMOR=y to the configure
  35 script:
  36
  37   $ ./configure CONFIG_VORBIS=y CONFIG_TREMOR=y
  38
  39 The Tremor library is supposed to be used on hardware that has no FPU.
  40
  41 Building
  42 --------
  43
  44   $ make
  45
  46 Or on some BSD systems you need to explicitly use GNU make:
  47
  48   $ gmake
  49
  50 Installation
  51 ------------
  52
  53   $ make install
  54
  55 Or to install to a temporary directory:
  56
  57   $ make install DESTDIR=/tmp/cmus
  58
  59 This is useful when creating binary packages.
  60
  61 Remember to replace 'make' with 'gmake' if needed.
  62
  63
  64 Mailing List
  65 ------------
  66
  67 To subscribe to cmus-devel@lists.sourceforge.net visit
  68
  69   http://lists.sourceforge.net/lists/listinfo/cmus-devel
  70
  71 The list is open but moderated (you can post to the list without
  72 subscribing but it's not recommended because I have to accept each email
  73 form non-subscribed users).  Traffic of the list is low.
  74
  75
  76 Reporting Bugs
  77 --------------
  78
  79 After a crash send bug report with last lines of /tmp/cmus-debug (or
  80 $TMPDIR/cmus-debug) to cmus-devel@lists.sourceforge.net.  The file
  81 exists only if you configured cmus with maximum debug level
  82 (./configure DEBUG=2).
  83
  84
  85 GIT Repository
  86 --------------
  87
  88 gitweb: http://repo.or.cz/w/cmus.git
  89 clone:  git://repo.or.cz/cmus.git cmus
  90
  91
  92 Hacking
  93 -------
  94
  95 cmus uses the Linux kernel coding style.  Use hard tabs. Tabs are
  96 _always_ 8 characters wide.  Keep the style consistent with rest of the
  97 code.
  98
  99 Use git format-patch to generate patches from your commits.
 100 Alternatively you can use "diff -up" if you don't want to use git.