From c921e0b6b691d02c09e993420fabea1fd02be1f8 Mon Sep 17 00:00:00 2001 From: "Jerome Blanchi aka d.j.a.y" Date: Tue, 12 Feb 2019 00:36:59 +0100 Subject: [PATCH] Improve help (#76 wip) - howtoplugins (done) * howtoplugins.txt --> .md --- README.md | 4 ++-- .../doc/{HowtoPlugins.txt => HowtoPlugins.md} | 15 ++++++++++----- veejay-current/veejay-server/doc/README.md | 2 +- 3 files changed, 13 insertions(+), 8 deletions(-) rename veejay-current/veejay-server/doc/{HowtoPlugins.txt => HowtoPlugins.md} (62%) diff --git a/README.md b/README.md index 5671bed5d..f1f6623d3 100644 --- a/README.md +++ b/README.md @@ -126,7 +126,7 @@ see also : [How to debug](./veejay-current/veejay-server/doc/HowToDebugging.txt) * Native YUV processing * Crash recovery -see also : [YUV processing](./veejay-current/veejay-server/doc/YCbCr.txt), [README Memory](./veejay-current/veejay-server/doc/REAMDE.memory), [README Performance](./veejay-current/veejay-server/doc/README.performance) +see also : [YUV processing](./veejay-current/veejay-server/doc/YCbCr.txt), [README Memory](./veejay-current/veejay-server/doc/README.memory.md), [README Performance](./veejay-current/veejay-server/doc/README.performance) ### Media @@ -208,7 +208,7 @@ see also : [How to video wall](./veejay-current/veejay-server/doc/video-wall.md) * Support for FreeFrame plugins (only for 32 bit systems!) * Android server! - see also : [How to Plugins](./veejay-current/veejay-server/doc/HowtoPlugins.txt), [README odroid-xu3](./veejay-current/veejay-server/doc/README.odroid-xu3) ,[README Android](./veejay-current/veejay-server/doc/README.android) + see also : [How to Plugins](./veejay-current/veejay-server/doc/HowtoPlugins.md), [README odroid-xu3](./veejay-current/veejay-server/doc/README.odroid-xu3) ,[README Android](./veejay-current/veejay-server/doc/README.android) ## Contact / Feedback & HELP diff --git a/veejay-current/veejay-server/doc/HowtoPlugins.txt b/veejay-current/veejay-server/doc/HowtoPlugins.md similarity index 62% rename from veejay-current/veejay-server/doc/HowtoPlugins.txt rename to veejay-current/veejay-server/doc/HowtoPlugins.md index 324fdff0d..2b520daf5 100644 --- a/veejay-current/veejay-server/doc/HowtoPlugins.txt +++ b/veejay-current/veejay-server/doc/HowtoPlugins.md @@ -1,19 +1,24 @@ -# Plugins +Plugins +======== By default, veejay looks in the following commmon locations to find plugins: +``` - /usr/local/lib - /usr/lib/ - /usr/local/lib64 - /usr/lib64 +``` Alternatively, you can create a file to tell veejay where to find plugins. - +``` $ mkdir ~/.veejay $ vi ~/.veejay/plugins +``` -The contents of the file can look like: - +Apart from the differences due to your OS, the contents of the file can look like: +``` /usr/local/lib/freeframe /usr/local/lib/frei0r-1 +``` -Veejay will pick up the plugins the next time you start it. +Veejay will pick up the plugins the next time you start it. diff --git a/veejay-current/veejay-server/doc/README.md b/veejay-current/veejay-server/doc/README.md index 785e9561f..f8b9f90ef 100644 --- a/veejay-current/veejay-server/doc/README.md +++ b/veejay-current/veejay-server/doc/README.md @@ -1,7 +1,7 @@ * [COPYING](./COPYING) * [HowtoCompile.txt](./HowtoCompile.txt) * [HowToDebugging.txt](./HowToDebugging.txt) -* [HowtoPlugins.txt](./HowtoPlugins.txt) +* Configure external video plugins - [How to Plugins](./HowtoPlugins.md) * [HowtoUbuntu.txt](./HowtoUbuntu.txt) * [HowtoVeejay-PureData.html](./HowtoVeejay-PureData.html) * [HowtoVideoCodecs.txt](./HowtoVideoCodecs.txt)