Browse Source

More cleanup, add repo:faq page

pull/14/head
falkTX 3 years ago
parent
commit
12020ba849
9 changed files with 118 additions and 36 deletions
  1. +4
    -13
      Documentation:Repository:Meta-Packages.php
  2. +0
    -1
      News/themes/stardust/layouts/default.twig
  3. +7
    -4
      Repositories.php
  4. +4
    -2
      Repositories:Applications.php
  5. +97
    -0
      Repositories:FAQ.php
  6. +4
    -2
      Repositories:Plugins.php
  7. +1
    -1
      _update-repo-pages.sh
  8. +1
    -1
      css/base.css
  9. +0
    -12
      includes/header.php

+ 4
- 13
Documentation:Repository:Meta-Packages.php View File

@@ -6,6 +6,10 @@ $PAGE_SOURCE_2 = ARRAY("Documentation", "Repository", "Meta-Packages");
include_once("includes/header.php");
?>

<p style="color:#fa3a3a;">
NOTE: The KXStudio repos are being reworked in a new setup, not all packages are available to install yet.
</p>

<p>
This section describes all the meta-packages available in the KXStudio repositories, splitted by type.
</p>
@@ -29,16 +33,11 @@ include_once("includes/header.php");
<li>kxstudio-meta-audio-plugins-ladspa</li>
<li>kxstudio-meta-audio-plugins-dssi</li>
<li>kxstudio-meta-audio-plugins-lv2</li>
<li>kxstudio-meta-audio-plugins-vamp</li>
<li>kxstudio-meta-audio-plugins-vst</li>
</ul>
</td></tr></table>
</li>
<li>kxstudio-meta-graphics</li>
<li>kxstudio-meta-video</li>
</ul></li>
<li>kxstudio-meta-restricted-extras</li>
<li>kxstudio-meta-wine</li>
</ul>

<h3><span class="mw-headline" id="MetaPackageDetails">Meta-Package Details</span></h3>
@@ -46,14 +45,6 @@ include_once("includes/header.php");
The main meta-packages are Audio, Audio-Plugins, Graphics and Video.<br/>
The Audio-Plugins meta-package is also split into plugin categories, for anyone that wants more plugins, but not actually more applications.<br/>
</p>
<p>
The 'meta-restricted-extras' is simply a combination of '[k|x]ubuntu-restricted-extras', plus alsa-firmware and linux-firmware-nonfree.<br/>
(In this case, "restricted" means that it can't be installed in Ubuntu by default, but you're safe to do it afterwards).
</p>
<p>
The 'meta-wine' includes Wine audio stuff, useful to install if you want to use Windows plugins after installing the KXStudio ISO.<br/>
This includes carla's Windows bridges, dssi-vst, festige, LMMS VST support and WineASIO.
</p>

<h3><span class="mw-headline" id="Notes">Notes</span></h3>
<p>


+ 0
- 1
News/themes/stardust/layouts/default.twig View File

@@ -11,7 +11,6 @@
<link rel="copyright" href="http://creativecommons.org/licenses/publicdomain/" />
<link rel="stylesheet" href="../css/style.fluid.css" type="text/css" media="screen" />
<link rel="stylesheet" href="../css/style.css" type="text/css" media="screen" />
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Raleway:200,700,800,400" type="text/css" media="screen" />
<link rel="icon" type="image/png" href="../images/ico_kxstudio.png" />
<link rel="shortcut icon" href="../favicon.ico" />
{% if site.clean_urls %}<link rel="canonical" href="{% if (post.url) %}$post.clean{% elseif page.url %}$page.clean {% else %}$site.url{% endif %}" />{% endif %}


+ 7
- 4
Repositories.php View File

@@ -10,8 +10,10 @@ $DEBIAN_PACKAGE_URL = "https://launchpad.net/~kxstudio-debian/+archive/kxstudio/

<div class="box box-description">
<p>
The KXStudio repositories support all Debian versions since <b>Buster</b> and Ubuntu <b>18.04</b> or above.<br/>
They should work on all Debian-based distributions and variants.
The KXStudio repositories support all Debian versions since <b>10 (Buster)</b> and Ubuntu <b>18.04 (Bionic)</b> or above.<br/>
They should work on all Debian-based distributions and variants.<br/>
A computer running intel-based 32bit or 64bit with SSE2 is required,
or alternatively an ARM-based system (32bit with neon-vfpv4 or 64bit).
</p>
<p>
Once you have the repos installed, you can either manually install individual packages from them or
@@ -25,6 +27,7 @@ $DEBIAN_PACKAGE_URL = "https://launchpad.net/~kxstudio-debian/+archive/kxstudio/
<ul>
<li><a href="<?php echo $ROOT; ?>/Repositories:Applications">Applications in the repositories</a></li>
<li><a href="<?php echo $ROOT; ?>/Repositories:Plugins">Plugins in the repositories</a></li>
<li><a href="<?php echo $ROOT; ?>/Repositories:FAQ">Frequent asked questions</a></li>
</ul>
<p>
Bug reports and package requests should be posted in the
@@ -49,13 +52,13 @@ $DEBIAN_PACKAGE_URL = "https://launchpad.net/~kxstudio-debian/+archive/kxstudio/
sudo apt-get install apt-transport-https gpgv

<span style="color: rgb(110, 110, 110);"># Download package file</span>
<?php echo $DEBIAN_PACKAGE_URL; ?>
<?php echo $DEBIAN_PACKAGE_URL . "\n"; ?>

<span style="color: rgb(110, 110, 110);"># Install it</span>
sudo dpkg -i kxstudio-repos_9.5.1~kxstudio3_all.deb
</pre>

<p><br/>
<p>
These packages contain:
</p>
<ul>


+ 4
- 2
Repositories:Applications.php View File

@@ -9,14 +9,16 @@ include_once("includes/header.php");
<div class="box box-description">
<p>
This section lists the applications available in the repositories.<br/>
Click on the yellow application name to install its respective package.<br/>
(If the links don't work, make sure you have the 'apturl-kde' or 'apturl' packages installed)
Click on the thumbnail to see the full-size image.<br/>
Individual deb files can be downloaded, requiring at least Debian 10 / Ubuntu 18.04 or superior.<br/>
If a "data" download is listed, it needs to be installed first before the architecture-dependent one.
</p>
<p>
You might also want to check:
</p>
<ul>
<li><a href="<?php echo $ROOT; ?>/Repositories:Plugins">Plugins in the repositories</a></li>
<li><a href="<?php echo $ROOT; ?>/Repositories:FAQ">Frequent asked questions</a></li>
</ul>
<br/>
</div>


+ 97
- 0
Repositories:FAQ.php View File

@@ -0,0 +1,97 @@
<?php
$PAGE_TITLE = "KXStudio : Repositories : FAQ";
$PAGE_TYPE = "KXSTUDIO";
$PAGE_SOURCE_1 = ARRAY("/Repositories", "/Repositories:FAQ");
$PAGE_SOURCE_2 = ARRAY("Repositories", "FAQ");
include_once("includes/header.php");
?>

<div class="box box-description">
<p>
This section contains frequent asked questions about the KXStudio repositories.
</p>
<p>
You might also want to check:
</p>
<ul>
<li><a href="<?php echo $ROOT; ?>/Repositories">General information and how to activate</a></li>
<li><a href="<?php echo $ROOT; ?>/Repositories:Applications">Applications in the repositories</a></li>
<li><a href="<?php echo $ROOT; ?>/Repositories:Plugins">Plugins in the repositories</a></li>
</ul>
</div>

<h5>How do I activate the KXStudio repos?</h5>
<p>
Just follow the instructions <a href="<?php echo $ROOT; ?>/Repositories">here</a>.
</p>

<h5>What computer systems are supported?</h5>
<p>
Any Debian or Ubuntu based system, running GNU/Linux.<br/>
For Debian, version 10 (Buster) is required; on Ubuntu, 18.04 (Bionic).<br/>
<br style="line-height:0.5em"/>
Intel-based and ARM-based systems are supported, 32 and 64bit for both.<br/>
For Intel-based systems a SSE2 capable CPU is required, while for ARM systems it is a neon-vfpv4 capable CPU.
</p>

<h5>I found an issue with a package, where can I report it?</h5>
<p>
Bug reports and package requests should be posted in the Github tracker
<a href="https://github.com/KXStudio/Repository/issues" target="_blank">here</a>.
</p>

<h5>Can I make a request for this new awesome-super-great application?</h5>
<p>
You can, but likely will not be answered back. The KXStudio repositories focus on audio plugins, not general applications.
</p>

<h5>Why are applications not the focus for the KXStudio repos?</h5>
<p>
A few reasons actually:
</p>
<ul>
<li>Applications can easily have flatpaks, snaps or whatever.<br/>
If they provide officially supported binaries, why not use them instead of duplicating efforts (of making binaries).</li>
<li>They often have very complex dependencies compared to plugins, some are actually quite difficult to build.</li>
<li>Distributions have a lot of margin to get things right, compared to plugins.<br/>
Plugins can be tricky for general GNU/Linux distributions, as they need to be self-contained.<br/>
Applications are mostly fine as long as they start.</li>
<li>Likely I will not use them, so they offer no benefit to me.</li>
</ul>

<h5>Why are plugins tricky for general distributions?</h5>
<p>
As you likely already know, we run a lot of audio plugins at the same time, all in the same process space.
If a single plugin misbehaves or crashes, it usually brings down the entire host or DAW.<br/>
</p>
<p>
So it vital that we build the plugins in a way to minimize issues.
They must be self-contained and never conflict with each other (as much as possible anyway).
This entails, for example:
</p>
<ul>
<li><b>Building all plugin code and its dependencies with hidden symbols</b>, so only the plugin-format-defined entry-points are visible within a shared object.<br/>
When this is not done, a plugin that uses a different audio library version from the host will crash.<br/>
This is usually not a problem if one uses only binaries from the distributions, but we cannot assume that it will always be that way...<br/>
Note that this is not just about building plugins in a certain, but also <b>all of its dependencies</b>.<br/>
<br style="line-height:0.5em"/>
For example: flatpaks, snaps, appimages and others include their own version of libraries needed by the application, which will publically expose symbols.<br/>
In such cases, loading a plugin that uses a library also used by the host will result in a crash if their target versions don't match.<br/>
Packages built in the KXStudio repositories do not have this issue.</li>
<li><b>SSE2 optimizations required to prevent denormals</b>.<br/>
We want to avoid denormals in audio applications, as it leads to very high CPU usage.<br/>
Checking for denormals on each buffer cycle is not cost-free for the CPU, but we can setup things so that they don't even happen to begin with!<br/>
This can be achieved by activating specific build flags (<i>-ffast-math -mfpmath=sse</i>) and set a few CPU flags in the audio thread.<br/>
Some plugins include such flags as part of their build rules, but not all.<br/>
Packages in the KXStudio repos have all these flags active (all plugin builds, plus audio threads set the needed CPU flags),
so denormals become a thing of the past. :)<br/>
<br style="line-height:0.5em"/>
Something to note is that distributions like Debian, which want to keep support for old hardware, cannot enable this.
This is because old hardware does not always have SSE2 support, so it becomes risky to enable it.</li>
</ul>

<p><br/></p>

<?php
include_once("includes/footer.php");
?>

+ 4
- 2
Repositories:Plugins.php View File

@@ -9,14 +9,16 @@ include_once("includes/header.php");
<div class="box box-description">
<p>
This section lists the audio plugins available in the repositories.<br/>
Click on the green plugin name to install its respective package.<br/>
(If the links don't work, make sure you have the 'apturl-kde' or 'apturl' packages installed)
Click on the thumbnail to see the full-size image.<br/>
Individual deb files can be downloaded, requiring at least Debian 10 / Ubuntu 18.04 or superior.<br/>
If a "data" download is listed, it needs to be installed first before the architecture-dependent one.
</p>
<p>
You might also want to check:
</p>
<ul>
<li><a href="<?php echo $ROOT; ?>/Repositories:Applications">Applications in the repositories</a></li>
<li><a href="<?php echo $ROOT; ?>/Repositories:FAQ">Frequent asked questions</a></li>
</ul>
<br/>
</div>


+ 1
- 1
_update-repo-pages.sh View File

@@ -4,5 +4,5 @@ set -e

pushd $(dirname $0)/repo
./generate-repo-page.sh apps > applications.html
# ./generate-repo-page.sh plugins > plugins.html
./generate-repo-page.sh plugins > plugins.html
popd

+ 1
- 1
css/base.css View File

@@ -74,7 +74,7 @@ blockquote{border-left:5px solid #690;color:#ddd;padding:10px;}
#content h1, #content h2, #content h3, #content h4, #content h5, #content h6{}
#header{font-size:0.8em;font-weight:bold;margin:0 0 25px;border-bottom:1px solid #222222;}
#header, #global-navigation li.selected{background: url('../images/gradient-dark-nav_mod.png') repeat-x scroll bottom left;} /* background:#666 */
#header, #global-navigation li{height:30px;font-family:"Raleway",sans-serif;}
#header, #global-navigation li{height:30px;font-family:sans-serif;}
#header-content{display:inline;}
#header ul#global-navigation{list-style:none inside;width:700px;float:left;}
#header ul#global-navigation, #global-navigation li{border-color:#222222;border-style:solid;margin:0;}


+ 0
- 12
includes/header.php View File

@@ -46,7 +46,6 @@ if (false && $PAGE_TYPE != "PASTE" && $PAGE_TYPE != "DONATIONS" && $PAGE_TYPE !=
<link rel="copyright" href="http://creativecommons.org/licenses/publicdomain/" />
<link rel="stylesheet" href="<?php echo $ROOT; ?>/css/style.fluid.css" type="text/css" media="screen" />
<link rel="stylesheet" href="<?php echo $ROOT; ?>/css/style.css" type="text/css" media="screen" />
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Raleway:200,700,800,400" type="text/css" media="screen" />
<link rel="icon" type="image/png" href="<?php echo $ROOT; ?>/images/ico_kxstudio.png" />
<link rel="shortcut icon" href="<?php echo $ROOT; ?>/favicon.ico" />
<?php if ($PAGE_TYPE == "HOME") { ?>
@@ -111,17 +110,6 @@ if (false && $PAGE_TYPE != "PASTE" && $PAGE_TYPE != "DONATIONS" && $PAGE_TYPE !=

</script>
<?php if (false && $PAGE_TYPE == "DONATIONS") { ?>
<script type="text/javascript">
/* <![CDATA[ */
(function() {
var s = document.createElement('script'), t = document.getElementsByTagName('script')[0];
s.type = 'text/javascript';
s.async = true;
s.src = 'https://api.flattr.com/js/0.6/load.js?mode=auto';
t.parentNode.insertBefore(s, t);
})();
/* ]]> */
</script>
<style type="text/css">
html > body .liberapay-btn {
background-color: #f6c915;


Loading…
Cancel
Save