multimedia/stopmotion/README.md

0001 Linux Stopmotion
0002 ================
0003
0004 Stopmotion is a program to create stop motion animations.
0005 See <https://invent.kde.org/multimedia/stopmotion> and <http://linuxstopmotion.org> for more info.
0006
0007
0008 INSTALLATION
0009 ------------
0010
0011 You need the following packages installed to compile:
0012 - C++ compiler (g++ or Clang)
0013 - CMake
0014 - pkg-config
0015 - Qt5 >= 5.11 (development modules base, multimedia) (`qtbase5-dev`, `qttools5-dev-tools`, `qttools5-dev`, `qtmultimedia5-dev` and `libqt5multimedia5-plugins`)
0016 - libtar (`libtar-dev`)
0017 - libXML2 (`libxml2-dev`)
0018 - vorbisfile (`libvorbis-dev`)
0019
0020 For example, in Ubuntu or Debian you would open a terminal and type:
0021
0022     sudo apt install build-essential gdb qtbase5-dev qttools5-dev qttest5-dev-tools libtar-dev libxml2-dev libvorbis-dev pkg-config git vgrabbj uvccapture
0023
0024 In openSUSE you type:
0025
0026     sudo zypper install cmake gcc-c++ libQt5Core-devel libQt5Widgets-devel libQt5Multimedia5 libtar-devel libvorbis-devel libxml2-devel
0027
0028 Once the dependencies are installed you can navigate to the source
0029 code directory and type the following to build Stopmotion:
0030
0031     mkdir build-cmake
0032     cd build-cmake
0033     cmake ..
0034     cmake --build .
0035
0036 If you want to install, make sure the user has sufficient rights (or switch to su)
0037
0038     cmake --install .
0039
0040
0041 WHO CAN USE IT
0042 --------------
0043 Everyone can use this application as it is distributed under the
0044 GPL licence (See the file `COPYING` for more details).
0045
0046
0047 DO YOU WANT TO CONTRIBUTE?
0048 --------------------------
0049 Do not hesitate to contact us if you want to contribute with translations,
0050 graphics, code, +++
0051
0052 The mailing list is at `linuxstopmotion-users-devs@lists.sourceforge.net`
0053
0054 Your help is very much appreciated.
0055
0056 DEVELOPMENT
0057 -----------
0058
0059 After `cmake`, the following make targets are available:
0060
0061 - `make`: build the project, the resulting executable is called `stopmotion`
0062 - `make test-stopmotion`: build unit tests
0063 - `make test`: run the unit tests
0064 - `make clean`: remove all build products
0065 - `make install`: install stopmotion
0066
0067 You can tell CMake to install in a specific location:
0068
0069     cmake -DCMAKE_INSTALL_PREFIX=<specific/location> <path/to/source/dir>
0070
0071 You can also specify the path to the translation and HTML documentation path
0072 by setting `-DTRANSLATION_PATH=` and `-DHTML_PATH=`.
0073
0074 Please see `src/domain/undo/README.md` for some notes on Stopmotion's
0075 architecture.