Browse Source

In default install variable

Bob Mottram 8 years ago
parent
commit
0f5fde7afe
2 changed files with 23 additions and 15 deletions
  1. 5
    1
      doc/EN/devguide.org
  2. 18
    14
      website/EN/devguide.html

+ 5
- 1
doc/EN/devguide.org View File

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

+ 18
- 14
website/EN/devguide.html View File

@@ -3,7 +3,7 @@
3 3
 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
4 4
 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
5 5
 <head>
6
-<!-- 2016-10-19 Wed 21:35 -->
6
+<!-- 2016-10-19 Wed 21:56 -->
7 7
 <meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
8 8
 <meta name="viewport" content="width=device-width, initial-scale=1" />
9 9
 <title></title>
@@ -245,17 +245,17 @@ for the JavaScript code in this tag.
245 245
 
246 246
 <center><h1>Developers Guide</h1></center>
247 247
 
248
-<div id="outline-container-org4f087f2" class="outline-2">
249
-<h2 id="org4f087f2">Introduction</h2>
250
-<div class="outline-text-2" id="text-org4f087f2">
248
+<div id="outline-container-org39dfc4d" class="outline-2">
249
+<h2 id="org39dfc4d">Introduction</h2>
250
+<div class="outline-text-2" id="text-org39dfc4d">
251 251
 <p>
252 252
 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.
253 253
 </p>
254 254
 </div>
255 255
 </div>
256
-<div id="outline-container-orgfc9fb59" class="outline-2">
257
-<h2 id="orgfc9fb59">Community Statement</h2>
258
-<div class="outline-text-2" id="text-orgfc9fb59">
256
+<div id="outline-container-org29d3dbd" class="outline-2">
257
+<h2 id="org29d3dbd">Community Statement</h2>
258
+<div class="outline-text-2" id="text-org29d3dbd">
259 259
 <p>
260 260
 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.
261 261
 </p>
@@ -273,9 +273,9 @@ This project also has a no bullshit policy. Anyone trying to cause a ruckus by t
273 273
 </p>
274 274
 </div>
275 275
 </div>
276
-<div id="outline-container-orgdef07c1" class="outline-2">
277
-<h2 id="orgdef07c1">Adding extra apps</h2>
278
-<div class="outline-text-2" id="text-orgdef07c1">
276
+<div id="outline-container-org1d5b416" class="outline-2">
277
+<h2 id="org1d5b416">Adding extra apps</h2>
278
+<div class="outline-text-2" id="text-org1d5b416">
279 279
 <p>
280 280
 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.
281 281
 </p>
@@ -324,12 +324,16 @@ An example template for an app script is shown below. Copy this and add whatever
324 324
 <span class="org-comment-delimiter"># </span><span class="org-comment">'full' includes your app in the full installation and you</span>
325 325
 <span class="org-comment-delimiter"># </span><span class="org-comment">can also add other variants, separated by spaces. The</span>
326 326
 <span class="org-comment-delimiter"># </span><span class="org-comment">available variants will be detected automatically from the</span>
327
-<span class="org-comment-delimiter"># </span><span class="org-comment">app scripts.</span>
327
+<span class="org-comment-delimiter"># </span><span class="org-comment">app scripts. In most cases don't change this.</span>
328 328
 <span class="org-variable-name">VARIANTS</span>=<span class="org-string">'full'</span>
329 329
 
330 330
 <span class="org-comment-delimiter"># </span><span class="org-comment">If you want this to appear on the control panel About screen</span>
331 331
 <span class="org-variable-name">SHOW_ON_ABOUT</span>=1
332 332
 
333
+<span class="org-comment-delimiter"># </span><span class="org-comment">If you want this app to be in the default installation,</span>
334
+<span class="org-comment-delimiter"># </span><span class="org-comment">otherwise it will not be available but not selected by default</span>
335
+<span class="org-variable-name">IN_DEFAULT_INSTALL</span>=1
336
+
333 337
 <span class="org-variable-name">SOME_IMPORTANT_CONFIG_VARIABLE</span>=<span class="org-string">'some important value'</span>
334 338
 <span class="org-variable-name">ANOTHER_IMPORTANT_CONFIG_VARIABLE</span>=<span class="org-string">'foo'</span>
335 339
 <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
540 544
 </div>
541 545
 </div>
542 546
 
543
-<div id="outline-container-orgfa34cfb" class="outline-2">
544
-<h2 id="orgfa34cfb">Customising mesh images</h2>
545
-<div class="outline-text-2" id="text-orgfa34cfb">
547
+<div id="outline-container-org2c02012" class="outline-2">
548
+<h2 id="org2c02012">Customising mesh images</h2>
549
+<div class="outline-text-2" id="text-org2c02012">
546 550
 <p>
547 551
 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.
548 552
 </p>