README

Nightingale is a community based fork of the Songbird Web/Media player
distributed under the GNU GPL and portions (xulrunner and mozilla libs)
licensed under the Mozilla MPL/BSD license. 

The goal of Nightingale is to create a multiplatform  player, which will 
eventually use only system libraries under Linux to conserve space and
avoid being redundant. Currently, some libraries are still bundled, 
but progress is being made to change this fact.

This git tree is the work in progress tree, based on the 1.10 tree of
Songbird. We are currently working on porting the code to use Gecko 6+
to further pursue the goal of having a player that works with system 
libraries. It currently won't build, but we're happy to have help in
getting it to the point of building and release.

The official repository is located at 
https://github.com/nightingale-media-player/nightingale-hacking

========================================================================
Notes:
========================================================================

*To build, git checkout nightingale-1.8 after cloning
the nightingale-hacking git repo from GitHub. You need to have all 
of the gstreamer0.10 packages for your distro, svn, wget, and git 
(if pulling the tree down) installed, as well as the usual dependencies
for building software upon your distro.

*If you get python errors, make sure you have python2 installed,
and try the build.sh script again.

*If it doesn't play music, you'll need to copy /usr/lib/gstreamer0.10/*
into compiled-dist-linux-[your arch]/dist/gst-plugins and then 
rerun nightingale. It should then play music.

========================================================================
Building:
========================================================================
If on Linux, simply run the build.sh script. It will download the deps
and build the app for you. You'll generally need the usual build deps
for most software packages, though.

Ubuntu and debian users should note you'll need:
libdbus-glib-1-dev
libgstreamer-plugins-base0.10-dev

More information can be gleaned from the Songbird wiki:

Windows: http://tinyurl.com/3jfo6lv
Mac: http://tinyurl.com/3bwg8e3
Linux: http://tinyurl.com/3kh3gk8

========================================================================
Configure Options:
========================================================================

  ac_add_options (option here)
  
  --enable-debug                        whether or not to compile debug
  --enable-jars                         whether or not to create jars
  --enable-installer                    whether or not to make installer
  --enable-official                     whether or not to official build
  --enable-nightly                      whether or not to nightly build
  --enable-tests                        whether or not to build tests
  --enable-update-channel=CHANNEL       which update channel to use
  --enable-breakpad                     whether or not to enable breakpad
  --enable-static                       single-component static build
  --enable-compiler-environment-checks  only allow supported compilers

========================================================================
Contributions:
========================================================================

To join in and help, please visit http://getnightingale.com/forum
or jump into #nightingale on irc.mozilla.org.

========================================================================
Contributors:
========================================================================

Auzy
GeekShadow
ilikenwf / Matt Parnell
Manko10
Mook
rsjtdrjgfuzkfg
steve-o

========================================================================
REMINDER!!!!
========================================================================

This is an opensource software, and everyone who works on it is a
volunteer! Don't be a troll towards the people giving you free
software and hard work!

░░░░░▄▄▄▄▀▀▀▀▀▀▀▀▄▄▄▄▄▄░░░░░░░
░░░░░█░░░░▒▒▒▒▒▒▒▒▒▒▒▒░░▀▀▄░░░░
░░░░█░░░▒▒▒▒▒▒░░░░░░░░▒▒▒░░█░░░
░░░█░░░░░░▄██▀▄▄░░░░░▄▄▄░░░░█░░
░▄▀▒▄▄▄▒░█▀▀▀▀▄▄█░░░██▄▄█░░░░█░
█░▒█▒▄░▀▄▄▄▀░░░░░░░░█░░░▒▒▒▒▒░█
█░▒█░█▀▄▄░░░░░█▀░░░░▀▄░░▄▀▀▀▄▒█
░█░▀▄░█▄░█▀▄▄░▀░▀▀░▄▄▀░░░░█░░█░
░░█░░░▀▄▀█▄▄░█▀▀▀▄▄▄▄▀▀█▀██░█░░
░░░█░░░░██░░▀█▄▄▄█▄▄█▄████░█░░░
░░░░█░░░░▀▀▄░█░░░█░█▀██████░█░░
░░░░░▀▄░░░░░▀▀▄▄▄█▄█▄█▄█▄▀░░█░░
░░░░░░░▀▄▄░▒▒▒▒░░░░░░░░░░▒░░░█░
░░░░░░░░░░▀▀▄▄░▒▒▒▒▒▒▒▒▒▒░░░░█░
░░░░░░░░░░░░░░▀▄▄▄▄▄░░░░░░░░█░░