aboutsummaryrefslogtreecommitdiff
path: root/Gem/README.txt
diff options
context:
space:
mode:
Diffstat (limited to 'Gem/README.txt')
-rw-r--r--Gem/README.txt157
1 files changed, 0 insertions, 157 deletions
diff --git a/Gem/README.txt b/Gem/README.txt
deleted file mode 100644
index d87427c..0000000
--- a/Gem/README.txt
+++ /dev/null
@@ -1,157 +0,0 @@
-This is GEM - Graphics Environment for Multimedia
-=================================================
-You can get the current distribution from:
-https://gem.iem.at
-https://git.iem.at/pd/Gem
-https://github.com/umlaeute/Gem
-
-if you want to compile the newest (bleeding edge, and possibly unstable) source
-code yourself, you can get a copy from the public git repository:
-
- https://git.iem.at/pd/Gem.git
-
-There is also a mirror on github:
- https://github.com/umlaeute/Gem
-
-usually, you will only need the read-only repository, which you can get with
-
-$ git clone https://git.iem.at/pd/Gem.git
-
-=============================================
-NEW:::
-------
-
-Gem is now supported by W32, linux and macOS-X
-the IRIX version might work (but most probably will not): if you want to use Gem
-under IRIX, feel free to make it work and report failure and success to me, so i
-can incorporate any needed changes into the main Gem-trunk.
-
-for installation instructions see below
-
--------------------------------------
--------------------------------------
-
-INSTALLATION:
-=============
-
--------------------------------------
-To build & install GEM run:
-$ ./configure
-$ make
-$ make install
-
-
-note: when using a git-clone of the Gem sources, you first need to run
-`./autogen.sh` (which is a wrapper around `autoreconf -fiv`).
-
-note: that you might want to help Gem to find the Pd-headers, e.g. by doing
-$ ./configure --with-pd=/usr/include/pd
-try
-$ ./configure --help=recursive
-to see more options.
-
--------------------------------------
-To install GEM on W32:
-a) installer (preferred method)
- use the installer executable to install Gem into ...\pd\extra
- (to _build_ the installer you will have to have NSIS installed
- see build/win-nsis for details)
-
-b) archive (do it by hand)
-
- 1) unzip the GEM package
-
- 2) put the subfolders of Gem-<version>\ into a directory where Pd will
- find it. If you are using an up-to-date version of Pd (>=0.43), put them
- into the folder "Application Data\Pd\" in your home directory.
- For older versions of Pd, put them into the "extra" folder of your Pd
- installation.
- e.g. if you installed Pd as "C:\Program Files\Pd-0.43-0" you should
- end up with:
- "C:\Program Files\Pd-0.43-0\extra\Gem"
- and eventually with
- "C:\Program Files\Pd-0.43-0\extra\pix_drum"
- "C:\Program Files\Pd-0.43-0\extra\pix_mano"
- ...
-
- there is no need to copy the README.txt found in Gem-<version>\
-
- 3) please note that the archive comes with all plugins
- in most cases, you won't need all of them, and having plugins
- installed that you don't need, will considerably slow down load
- time of patches and might leed to undesired side-effects.
- therefore, if loading is too slow (or you experience weird
- things), it might be a good idea to disable plugins you don't
- need.
- disabling plugins is as simple as deleting them (or moving them
- into a subfolder)
-
- plugins are files of the form: "gem_<type><NAME>.dll"
- e.g. "gem_filmQT.dll" is a plugin for reading films using the
- QuickTime framework.
- in order to use videoPYLON, videoHALCON and videoAVT, you need
- to install proprietary libraries yourself; if you haven't done
- so or don't own a device that can interact with those libraries,
- you can safely remove these plugins.
- if you have no clue what this is about, these plugins are most
- likely not for you (so remove them)
-
-
-
--------------------------------------
--------------------------------------
-
-RUNNING:
-========
-
-just installing Gem is not enough !
-you will have to tell Pd that it should load that library !!
-you cannot create any Gem-objects without having loaded the Gem-library into Pd !!!
-
-make sure you have the proper binary for you OS
- - windows: Gem.dll, Gem.m_i386, Gem.m_*
- - macOS-X: Gem.pd_darwin, Gem.d_fat, Gem.d_ppc, Gem.d_*
- - linux : Gem.pd_linux, Gem.l_i386, Gem.l_ia64, Gem.l_*
- - freeBSD: Gem.pd_freebsd, Gem.b_i386, Gem.b_*
- - irix : Gem.pd_irix
- - ...
-
-when starting Pd, tell it to load Gem with the "-lib" flag
-if your Gem-binary lives in pd/extra/, you could just try "pd -lib Gem"
-if your Gem-binary lives somewhere else use something like "pd -lib /path/to/my/Gem"
-you could also use "pd -path /path/to/my -lib Gem"
-after loading Gem you will see a bit of a welcome message on the konsole
-
-NOTE: there *must not* be any file extension with the "-lib"-flag.
- e.g. this will fail miserably:
- "pd -lib Gem.dll"
-NOTE: please note the spelling: it is "Gem" and not "gem" nor "GEM"
-
-if you have problems loading any library including Gem, have a look at the
-Pd-documentation.
-if you have problems loading just Gem (but other libraries work), send me a
-bug-report (see below)
-
-BUG-REPORTS:
-============
-please do not hesitate to report any crashes, weirdnesses or other issues, using
-our bugtracker at https://bugs.gem.iem.at
-or the gem-dev mailinglist (subscription at http://lists.puredata.info)
-
-if your mail only says "hey, it does not work !", it is an annoyance and no bug-report
-please specify at least the following things:
- Operating-System (kernel-version,...)
- video-card, driver
- other hardware that is related to your problem (e.g.: camera)
- does your system work with similar applications (e.g.: capture-software,
- openGL (games, "glxgears")
- what is the output of Pd when you start it with the "-verbose" flag
- (e.g.:"pd -verbose -lib Gem")
-
-please do not use the puredata bugtracker for reporting Gem-specific bugs.
-
-----
-have fun
-
-zmoelnig@iem.at
-