Commit 94df5f08 authored by Piotr Różański's avatar Piotr Różański Committed by Marian Dovgialo

#27275 Updated documentation

parent f99e8ef8
......@@ -37,18 +37,6 @@ directories PLUGIN-NAME/target. To run generated JAR, execute
java -jar svarog-standalone/target/svarog-standalone-*.jar
ATTENTION: This method runs Svarog without any plugins.
To run Svarog with all available plugins, you should
a) create symbolic links to JAR and XML files of all plugins you want
to run, linking from PLUGIN-NAME/target/PLUGIN-NAME.(xml|jar)
to directory $HOME/.svarog/plugins
OR
b) create a separate directory according to ZIP creation guide (below)
and run Svarog from that directory.
III. IDE configuration
----------------------
......@@ -70,7 +58,6 @@ Svarog consists of several connected Maven packages:
* Svarog-top, which is the top-most project, which, when built, builds
the entire Svarog with all dependencies
* Svarog, which is the main part of Svarog
* other separate projects, one for each plugin
Most of the source code of Svarog's main part is in directory
......@@ -87,25 +74,16 @@ defines the package, to which this class belongs:
package org.signalml.app;
Analogically, every Svarog plugins has its own package hierarchy,
starting in:
plugins/PLUGIN-NAME/src/main/java
IV. Working with translations
-----------------------------
The first step is to generate *.pot files from Svarog's code, as well as from
the source code of all the plugins. It is done by executing
The first step is to generate *.pot files from Svarog's source code.
It is done by executing
mvn gettext:gettext
in the "svarog" directory as well as in the directory of each plugin.
Next, the resulting *.pot files have to be merged into one *.pot file.
Utility "msgcat" can be used to accomplish this, and it is preferable
to call it with "-s" ("--sort-output") flag.
in the "svarog" directory.
The resulting *.pot file can be used to initialize a new translation
by the use of "msginit" command. This will create an empty *.po
......@@ -158,7 +136,6 @@ VI. Creating ZIP file for github Releases
ZIP package consists of:
a) Svarog's JAR file
b) plugins' JAR and XML files
c) executable script run_svarog.sh
d) an example signal wakeEEG.bin with corresponding XML file
e) binary executables of MP5 and empi
......@@ -166,7 +143,7 @@ e) binary executables of MP5 and empi
The most recent ZIP file can be used to provide all the files except
a) and b). Afterwards, it is necessary to:
* replace Svarog's JAR file and plugins' files, if they have changed
* replace Svarog's JAR file, if it has changed
* replace version number in run_svarog.sh
* make a ZIP file with the new name (check if the name of the package
corresponds to the package's main directory)
......
......@@ -12,10 +12,6 @@ build
mkdir -p dist
movedeb svarog-standalone/target/*.deb
movedeb plugins/BookReporter/target/*.deb
movedeb plugins/FFTSignalTool/target/*.deb
movedeb plugins/PluginToolCommon/target/*.deb
movedeb plugins/SignalAnalysisPlugin/target/*.deb
cp svarog-all.template dist/svarog-all
cd dist
......
......@@ -7,11 +7,10 @@ set -e
build
dest="dist/svarog-$VERSION-standalone"
mkdir -p "$dest/plugins"
mkdir -p "$dest"
mv standalone-package-files/* "$dest"
mv svarog-standalone/target/*.jar "$dest/svarog-standalone.jar"
mv plugins/*/target/*.{jar,xml} "$dest/plugins/"
cp LICENSE.txt "$dest"
cd dist
......
......@@ -3,9 +3,5 @@ set -e
#GPG_KEY - enviroment variable - private key in base64
echo "$GPG_KEY" | base64 -d | gpg --allow-secret-key-import --import -
cd dist
debsigs --sign=origin svarog-bookreporter_*.deb
debsigs --sign=origin svarog-fftsignaltool_*.deb
debsigs --sign=origin svarog-plugintoolcommon_*.deb
debsigs --sign=origin svarog-signalanalysisplugin_*.deb
debsigs --sign=origin svarog_*.deb
debsigs --sign=origin svarog-all_*.deb
......@@ -10,7 +10,7 @@ Package: svarog-all
Version: VERSION
# Maintainer: Your Name <yourname@example.com>
# Pre-Depends: <comma-separated list of packages>
Depends: svarog-artifact, svarog-bookreporter, svarog-fftsignaltool, svarog-plugintoolcommon, svarog-signalanalysisplugin, svarog-stager, svarog, empi, vlc
Depends: svarog, empi, vlc
# Recommends: <comma-separated list of packages>
# Suggests: <comma-separated list of packages>
# Provides: <comma-separated list of packages>
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment