INSTALL.txt 2.4 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768
  1. This project uses git submodules and several are required for a successful
  2. build. If this tarball was NOT provided with submodules (default), some source
  3. dependencies will need to be manually added to src/3rdparty.
  4. If this project WAS provided with submodules, there are detailed dependencies
  5. (e.g. supported compilers, cmake requirements, cross-compilation) at
  6. doc/wiki/Compiling.md including platform-specific build instructions (e.g.
  7. apt-get, dnf, pacman, etc).
  8. Online documentation:
  9. https://github.com/LMMS/lmms/wiki/
  10. Live online chat via Discord (similar to IRC):
  11. https://lmms.io/chat, Channel #programming
  12. Basic build steps:
  13. mkdir build
  14. cd build
  15. cmake ../
  16. make
  17. sudo make install
  18. # or alternately: su -c 'make install'
  19. With the above commands an out-of-tree build is performed. You can also run
  20. "cmake ." directly in the root of source tree although this is not recommended.
  21. When performing an out-of-tree build after there's already an in-tree build,
  22. make sure to run "make distclean" before running cmake inside build-directory.
  23. If you want to use custom compiler flags simply set the environment variables
  24. CFLAGS and CXXFLAGS.
  25. After running cmake (the 3rd command above) you can see a summary of things
  26. that are going to be built into LMMS or built as plugins. Install the
  27. according libraries and development files if a certain feature is not enabled.
  28. Then remove CMakeCache.txt and run cmake again.
  29. For non-root installs, or to install to a non-standard location, provide an
  30. install prefix to cmake, using the flag:
  31. -DCMAKE_INSTALL_PREFIX=<prefix>
  32. The Compilation tutorial (see docs/wiki/Compilation.md)
  33. specifically uses <prefix> as "../target" for all non-root installations. This
  34. is strongly recommended if developing a patch or a feature. For root
  35. installations, <prefix> can be /usr, /usr/local, /opt, etc. For most systems,
  36. the default is /usr/local.
  37. If your Qt5 installation does not reside in standard installation paths,
  38. additionally pass:
  39. -DCMAKE_PREFIX_PATH=<prefix>
  40. Where <prefix> is the location to Qt5 installation, usually /opt/qt5/, etc.
  41. Important wiki sections:
  42. doc/wiki/Compiling.md:
  43. Dependencies Detailed
  44. - Build Toolchain (cmake)
  45. - Compiler (gcc, clang)
  46. - Libraries (required and optional dependencies)
  47. doc/wiki/Dependencies-<platform>.md
  48. Platform-specific dependencies (Windows, Ubuntu, Fedora, macOS, etc.)