multimedia/stopmotion/README.md

0001 Linux Stopmotion
0002 ================
0003
0004 Stopmotion is a program to create stop motion animations.
0005 See <http://linuxstopmotion.org> for more info.
0006
0007
0008 INSTALLATION
0009 ------------
0010
0011 You need the following packages installed to compile:
0012 - make and gcc (`build-essential`)
0013 - `gdb`
0014 - Qt5 (`qtbase5-dev`, `qttools5-dev-tools`, `qtmultimedia5-dev` and `libqt5multimedia5-plugins`)
0015 - tar (`libtar-dev`)
0016 - XML2 (`libxml2-dev`)
0017 - vorbisfile (`libvorbis-dev`)
0018 - `pkg-config`
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 qttest5-dev-tools libtar-dev libxml2-dev libvorbis-dev pkg-config git vgrabbj uvccapture
0023
0024 In OpenSuSE you first type:
0025
0026     sudo zypper install -t pattern devel_qt5
0027     sudo zypper install git libvorbis-devel libxml2-devel
0028
0029 Then open your browser and visit `https://rpm.pbone.net` and find both
0030 `libtar`, `libtar1` and `libtar-devel` for the correct OS version, each
0031 with the exact same version. Then install them like this (changing the
0032 filenames as appropriate):
0033
0034     sudo rpm -i ~/Downloads/libtar1-1.2.20-2.8.x86_64.rpm ~/Downloads/libtar-1.2.20-2.8.x86_64.rpm ~/Downloads/libtar-devel-1.2.20-2.8.x86_64.rpm
0035
0036 Once the dependencies are installed you can navigate to the source
0037 code directory and type the following to build Stopmotion:
0038
0039     qmake -qt=5
0040     sudo make install
0041
0042 If `qmake -qt=5` does not work, you can just use `qmake`.
0043
0044
0045 WHO CAN USE IT
0046 --------------
0047 Everyone can use this application as it is distributed under the
0048 GPL licence (See the file `COPYING` for more details).
0049
0050
0051 DO YOU WANT TO CONTRIBUTE?
0052 --------------------------
0053 Do not hesitate to contact us if you want to contribute with translations,
0054 graphics, code, +++
0055
0056 The mailing list is at `linuxstopmotion-users-devs@lists.sourceforge.net`
0057
0058 Your help is very much appreciated.
0059
0060 DEVELOPMENT
0061 -----------
0062
0063 After qmake, the following make targets are available:
0064
0065 - `make`: build a release version of the project, called stopmotion
0066 - `make debug`: build a debug version of the project, called stopmotion-d
0067 - `make all`: both debug and release versions
0068 - `make test`: build and run the unit tests
0069 - `make clean`: remove all build products
0070 - `make install`: install stopmotion
0071 - `make uninstall`: remove installation
0072
0073 To install in a specific location:
0074
0075     qmake PREFIX=/specific/location HTML_PATH=/docs/go/here TRANSLATIONS_PATH=/translations/go/here
0076     sudo make install
0077
0078 The defines are optional. `PREFIX` defaults to `/usr/local`.
0079 `HTML_PATH` defaults to `${PREFIX}/share/doc/stopmotion/html`.
0080 `TRANSLATIONS_PATH` defaults to `${PREFIX}/share/doc/stopmotion/translations`.
0081
0082 To put the files somewhere before copying them for installation (after `qmake`):
0083
0084     make INSTALL_ROOT=/somewhere/writeable install
0085     cp -fr /somewhere/writeable/* /
0086
0087 `PREFIX` is where the files will ultimately end up. `make install` will put them in
0088 `$(INSTALL_ROOT)$(PREFIX)`
0089
0090 Please see `src/domain/undo/README.md` for some notes on Stopmotion's
0091 architecture.