/*============================================================================*/
/*                                                                            */
/*                                                                            */
/*                          Digital Scratch Player                            */
/*                An audio file player driven by vinyl turntable              */
/*                                                                            */
/*                                                                            */
/*============================================================================*/


-- Building requirements -------------------------------------------------------

[Compiler]
- GCC (g++-5.x):           http://gcc.gnu.org
or
- MS VS 2013 Community:    https://www.visualstudio.com/en-us/products/visual-studio-community-vs.aspx

[Libraries]
- Qt SDK (qt5.x):          http://www.qt.io
- FFmpeg:                  https://www.ffmpeg.org/
- Digital Scratch library: http://www.digital-scratch.org
- Sample rate library:     http://www.mega-nerd.com/SRC/
- JACK library:            http://jackaudio.org
- LibKeyFinder:            http://www.ibrahimshaath.co.uk/keyfinder/
- ALSA library:            http://www.alsa-project.org

[Ubuntu 18.10]
- build-essential
- qt5-default
- libavformat-dev
- libavcodec-dev
- libavutil-dev
- libswresample-dev
- libjack-jackd2-dev
- libsamplerate0-dev
- qtmultimedia5-dev
- libqt5multimedia5-plugins
- libasound2-dev
- libdigitalscratch-dev    (ppa:julien-rosener/digitalscratch)
- libkeyfinder-dev         (ppa:julien-rosener/digitalscratch)

[MS Windows]
- Install MS VS 2013 Community
- Standalone Debugging Tools for Windows (WinDbg): https://www.microsoft.com/click/services/Redirect2.ashx?CR_EAC=300135395
- Install Qt 5.x for Windows 32-bit (MSVC 2013, OpenGL)
- All dependencies are available as binaries in folder win-external/

-- Build -----------------------------------------------------------------------

[GNU/Linux]
- qmake
- make
- sudo make install
=> more info: https://github.com/jrosener/digitalscratch/wiki/Build-DigitalScratch-on-Ubuntu

[MS Windows]
- Start Qt Creator
- Load project digitalscratch.pro:
  - Use the build kit which uses the compiler from Visual Studio 2013 Community.
  - Set the output directory to digitalscratch\ (Debug and Release build configuration).
- Right click on project digitalscratch, then "Run qmake", then "Build".
=> more info: https://github.com/jrosener/digitalscratch/wiki/Build-DigitalScratch-on-Windows


-- Build test suite ------------------------------------------------------------

[GNU/Linux]
- qmake CONFIG+=test
- make

[MS Windows]
- In Qt Creator, create a new build target based on the "Debug" one.
- Add to the build steps: CONFIG+=test
- Right click on project libdigitalscratch, then "Run qmake", then "build"


-- Playing requirements --------------------------------------------------------

- Jack audio server: http://jackaudio.org/
- QJackCtl Jack GUI: http://qjackctl.sourceforge.net/


-- Play ------------------------------------------------------------------------

[GNU/Linux]
- qjackctl (configure the sound card)
- digitalscratch
=> more info: https://github.com/jrosener/digitalscratch/wiki/Run-DigitalScratch-on-Ubuntu

[MS Windows]
- Install and configure Jack for Windows (http://jackaudio.org/download)
- Start digitalscratch.exe
=> more info: https://github.com/jrosener/digitalscratch/wiki/Run-DigitalScratch-on-Windows
