README

HOW TO MAKE IT RUN

          1. Install dependencies. See "BUILD DEPENDENCIES, *" below in this file.

	  2. Inspect the file "configuration.sh" and see if you want to change anything.
	  
          3. Do this:

          "
          make packages
          BUILDTYPE=RELEASE ./build_linux.sh -j `nproc`
          QT_QPA_PLATFORM_PLUGIN_PATH=`$(./find_moc_and_uic_paths.sh qmake) -query QT_INSTALL_PLUGINS` bin/radium
          "

          Note: There is an install.sh script, and it works, but you don't need it to run the program.
	  

IF YOU GOT THE SOURCE FROM GIT

     WARNING: Only release-tagged commits should be considered stable.
     If you only do "git clone" and compile that version of Radium, there's
     a good chance the program won't compile, or will crash.

     You can download a stable version of the source by doing:
     
         wget https://github.com/kmatheussen/radium/archive/<version>.tar.gz

     However, if you still want to use GIT, you sometimes have to execute
     
          make very_clean

     ...after a git pull, since not all dependencies are tracked in the makefile.



IF YOU ARE DEVELOPING RADIUM

     First inspect the file "configuration.sh" and see if you want to change anything.
	  
     Then run these lines:
     
        # Debug build. Lots of assertions. Very slow. Don't build this version if you are just testing the program.
        make packages # Only necessary one time.
        BUILDTYPE=DEBUG_FAST ./build_linux.sh -j`nproc` && ./run_gdb.sh

     There are three types of BUILD_TYPE:
     
        RELEASE    - Compiled with -O2/-O3 and without various assertions.
        DEBUG_FAST - Same as DEBUG + -O2/-O3. Quite slow, but usually acceptable.
        DEBUG      - Compiled with -O0/-ggdb + asan/etc + various assertions. Very slow if your
		     computer is from around 2013 or older. If so it's usually
                     better to use DEBUG_FAST and temporarily add -O0 to the Makefile for those files
                     where you need better debug info.



INTRODUCTION
        Radium is a free (as in speech) music editor with a novel interface.
        It's inspired by trackers, but has fewer limitations and uses graphics to show musical data. 



BUILD DEPENDENCIES, all platforms:

        * VST headers from steinberg. The necessary files should be incuded in
          "VST Audio Plug-Ins SDK", which you can download here:

             http://www.steinberg.net/en/company/developers.html

         After downloading the VST SDK, unpack it into your ~/SDKs folder.



BUILD DEPENDENCIES, fedora:

        In addition to OpenGL, you also need:

        python2-devel
        alsa-lib-devel
        jack-audio-connection-kit-devel
        libsamplerate-devel
        liblrdf-devel
        libsndfile-devel
        ladspa-devel
        glib2-devel
        ladspa-calf-plugins
        binutils-devel
        libtool-ltdl
        libtool
        tk
        libogg-devel
        libvorbis-devel
        speex-devel
        fftw-devel
        guile
        libxkbfile-devel
        xorg-x11-util-macros
        cmake
        libXrandr-devel
        llvm-devel
        boost-devel
        openssl-devel
        ncurses-devel
        xcb-util-keysyms-devel
        qt5-qtbase-gui
        qt5-qttools-common
        qt5-qtwebkit-devel
        qt5-qtx11extras-devel
        qt5-qttools-static
        gmp-devel
        mpfr-devel
        libmpc-devel
        
        * Or in one line:

        qt4-devel python2-devel alsa-lib-devel jack-audio-connection-kit-devel libsamplerate-devel liblrdf-devel libsndfile-devel ladspa-devel glib2-devel ladspa-calf-plugins binutils-devel libtool-ltdl libtool tk libogg-devel libvorbis-devel speex-devel fftw-devel guile libxkbfile-devel xorg-x11-util-macros cmake libXrandr-devel qtwebkit-devel llvm-devel boost-devel openssl-devel ncurses-devel xcb-util-keysyms-devel qt5-qtbase-gui qt5-qtwebkit-devel qt5-qtx11extras-devel qt5-qttools-static gmp-devel mpfr-devel libmpc-devel

        (tested on Fedora 17/19/20/22 64 bit)



BUILD DEPENDENCIES, ubuntu/debian/etc.:
      * Main packages, Ubuntu 12:

      In addition to OpenGL, you also need:

      python2-dev
      libasound2-dev
      libjack-jackd2-dev or libjack-jackd1-dev
      libsamplerate-dev
      liblrdf-dev
      libsndfile-dev
      ladspa-sdk
      glib2-dev
      calf-plugins
      binutils-dev
      libc6-dev
      tk8.5
      libogg-dev
      libvorbis-dev
      libspeex-dev
      fftw-dev
      fftw3-dev
      guile
      libxkbfile-dev
      xorg-x11-util-macros
      cmake
      libfreetype6-dev
      libxinerama-dev
      libxcursor-dev
      libxrandr-dev
      llvm-dev
      libboost-all-dev
      libssl-dev
      ncurses-dev
      libxcb-keysyms1-dev
      qt5-dev
      qt5webkit-dev
      qt5x11extras-dev
      qt5-qttools-static-dev
      qtbase5-private-dev
      gmp-dev
      mpfr-dev
      libmpc-dev
      
      * Or in one line:

      sudo apt-get install python2-dev       libasound2-dev       libjack-jackd2-dev     libsamplerate-dev       liblrdf-dev       libsndfile-dev      ladspa-sdk      glib2-dev      calf-plugins      binutils-dev      libc6-dev      tk8.5 libogg-dev libvorbis-dev libspeex-dev fftw-dev fftw3-dev guile libxkbfile-dev xorg-x11-util-macros cmake libfreetype6-dev libxinerama-dev libxcursor-dev libxrandr-dev libqtwebkit-dev llvm-dev libboost-all-dev libssl-dev ncurses-dev libxcb-keysyms1-dev qt5-dev qt5webkit-dev qt5x11extras-dev qt5-qttools-static-dev qtbase5-private-dev gmp-dev mpfr-dev libmpc-dev


      * Ubuntu LTS: I needed glib-2.0-dev instead of glib2-dev, plus a package called libglib2.0-dev.
        I also needed to install python2.7-dev instead of python2-dev.

      * On debian stable, it has been reported that you also need libfftw3-dev.

      * Ubuntu 14: Replace glib-2.0-dev with libglib2.0-dev. Add libiberty-dev




ACKNOWLEDGMENT
        See http://users.notam02.no/~kjetism/radium/documentation.php#acknowledgment



CONTACT
	k.s.matheussen@notam02.no
	http://www.notam02.no/radium/