In default install variable

This commit is contained in:
Bob Mottram 2016-10-19 21:56:34 +01:00
parent 1993ec653c
commit 0f5fde7afe
2 changed files with 23 additions and 15 deletions

View File

@ -61,12 +61,16 @@ An example template for an app script is shown below. Copy this and add whatever
# 'full' includes your app in the full installation and you
# can also add other variants, separated by spaces. The
# available variants will be detected automatically from the
# app scripts.
# app scripts. In most cases don't change this.
VARIANTS='full'
# If you want this to appear on the control panel About screen
SHOW_ON_ABOUT=1
# If you want this app to be in the default installation,
# otherwise it will not be available but not selected by default
IN_DEFAULT_INSTALL=1
SOME_IMPORTANT_CONFIG_VARIABLE='some important value'
ANOTHER_IMPORTANT_CONFIG_VARIABLE='foo'
MY_FUNKY_AVATAR=https://some-domain-or-other/fro.png

View File

@ -3,7 +3,7 @@
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
<!-- 2016-10-19 Wed 21:35 -->
<!-- 2016-10-19 Wed 21:56 -->
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<title></title>
@ -245,17 +245,17 @@ for the JavaScript code in this tag.
<center><h1>Developers Guide</h1></center>
<div id="outline-container-org4f087f2" class="outline-2">
<h2 id="org4f087f2">Introduction</h2>
<div class="outline-text-2" id="text-org4f087f2">
<div id="outline-container-org39dfc4d" class="outline-2">
<h2 id="org39dfc4d">Introduction</h2>
<div class="outline-text-2" id="text-org39dfc4d">
<p>
Freedombone consists of a set of bash scripts. There are a lot of them, but they're not very complicated. If you're familiar with the GNU/Linux commandline and can hack a bash script then you can probably add a new app or fix a bug in the system. There are no trendy development frameworks to learn or to get in your way.
</p>
</div>
</div>
<div id="outline-container-orgfc9fb59" class="outline-2">
<h2 id="orgfc9fb59">Community Statement</h2>
<div class="outline-text-2" id="text-orgfc9fb59">
<div id="outline-container-org29d3dbd" class="outline-2">
<h2 id="org29d3dbd">Community Statement</h2>
<div class="outline-text-2" id="text-org29d3dbd">
<p>
This project doesn't require you to take any special pledge of allegiance or subscribe to any guru's list of commandments. It does not care about your gender, race, national flag or political alignment. It is agnostic towards your religion or lack thereof. It doesn't give one hoot as to whether you are young or old, rich or poor, gay, trans, straight or just "other". It does not care if you like your eggs sunny side up or if you are a vegan.
</p>
@ -273,9 +273,9 @@ This project also has a no bullshit policy. Anyone trying to cause a ruckus by t
</p>
</div>
</div>
<div id="outline-container-orgdef07c1" class="outline-2">
<h2 id="orgdef07c1">Adding extra apps</h2>
<div class="outline-text-2" id="text-orgdef07c1">
<div id="outline-container-org1d5b416" class="outline-2">
<h2 id="org1d5b416">Adding extra apps</h2>
<div class="outline-text-2" id="text-org1d5b416">
<p>
Suppose you have some internet application which you want to add to the system. To do this you need to create an app script which tells the system how to install/remove and also backup/restore. The script should be designed to work with the current stable version of Debian.
</p>
@ -324,12 +324,16 @@ An example template for an app script is shown below. Copy this and add whatever
<span class="org-comment-delimiter"># </span><span class="org-comment">'full' includes your app in the full installation and you</span>
<span class="org-comment-delimiter"># </span><span class="org-comment">can also add other variants, separated by spaces. The</span>
<span class="org-comment-delimiter"># </span><span class="org-comment">available variants will be detected automatically from the</span>
<span class="org-comment-delimiter"># </span><span class="org-comment">app scripts.</span>
<span class="org-comment-delimiter"># </span><span class="org-comment">app scripts. In most cases don't change this.</span>
<span class="org-variable-name">VARIANTS</span>=<span class="org-string">'full'</span>
<span class="org-comment-delimiter"># </span><span class="org-comment">If you want this to appear on the control panel About screen</span>
<span class="org-variable-name">SHOW_ON_ABOUT</span>=1
<span class="org-comment-delimiter"># </span><span class="org-comment">If you want this app to be in the default installation,</span>
<span class="org-comment-delimiter"># </span><span class="org-comment">otherwise it will not be available but not selected by default</span>
<span class="org-variable-name">IN_DEFAULT_INSTALL</span>=1
<span class="org-variable-name">SOME_IMPORTANT_CONFIG_VARIABLE</span>=<span class="org-string">'some important value'</span>
<span class="org-variable-name">ANOTHER_IMPORTANT_CONFIG_VARIABLE</span>=<span class="org-string">'foo'</span>
<span class="org-variable-name">MY_FUNKY_AVATAR</span>=https://some-domain-or-other/fro.png
@ -540,9 +544,9 @@ Submit your working app to <b><a href="https://github.com/bashrc/freedombone/iss
</div>
</div>
<div id="outline-container-orgfa34cfb" class="outline-2">
<h2 id="orgfa34cfb">Customising mesh images</h2>
<div class="outline-text-2" id="text-orgfa34cfb">
<div id="outline-container-org2c02012" class="outline-2">
<h2 id="org2c02012">Customising mesh images</h2>
<div class="outline-text-2" id="text-org2c02012">
<p>
If you want to make your own specially branded version of the mesh images, such as for a particular event, then to change the default desktop backgrounds edit the images within <b>img/backgrounds</b> and to change the available avatars and desktop icons edit the images within <b>img/avatars</b>. Re-create disk images using the instructions shown previously.
</p>