Bob Mottram пре 7 година
родитељ
комит
4abab0104a
2 измењених фајлова са 40 додато и 18 уклоњено
  1. 15
    4
      doc/EN/devguide.org
  2. 25
    14
      website/EN/devguide.html

+ 15
- 4
doc/EN/devguide.org Прегледај датотеку

@@ -24,25 +24,36 @@ There's a command which you can use to generate scripts for new apps. Some examp
24 24
 To create a script for a generic PHP plus MySql/MariaDB web app:
25 25
 
26 26
 #+begin_src bash
27
-freedombone-template --app [name] -e [email] -r [repo url] -c [commit] --php yes -d mariadb > src/freedombone-app-myappname
27
+freedombone-template --app [name] -e [email] -r [repo url] \
28
+                     -c [commit] --php yes -d mariadb > \
29
+                     src/freedombone-app-myappname
28 30
 #+end_src
29 31
 
30 32
 For a Nodejs app with MySql/MariaDB database:
31 33
 
32 34
 #+begin_src bash
33
-freedombone-template --app [name] -e [email] -r [repo url] -c [commit] --node yes -d mariadb --dir /etc/myappname --daemon yes > src/freedombone-app-myappname
35
+freedombone-template --app [name] -e [email] -r [repo url] \
36
+                     -c [commit] --node yes -d mariadb \
37
+                     --dir /etc/myappname --daemon yes > \
38
+                     src/freedombone-app-myappname
34 39
 #+end_src
35 40
 
36 41
 For a Python app with Postgresql database:
37 42
 
38 43
 #+begin_src bash
39
-freedombone-template --app [name] -e [email] -r [repo url] -c [commit] -d postgresql --dir /etc/myappname --daemon yes > src/freedombone-app-myappname
44
+freedombone-template --app [name] -e [email] -r [repo url] \
45
+                     -c [commit] -d postgresql \
46
+                     --dir /etc/myappname --daemon yes > \
47
+                     src/freedombone-app-myappname
40 48
 #+end_src
41 49
 
42 50
 For a Python app without any database:
43 51
 
44 52
 #+begin_src bash
45
-freedombone-template --app [name] -e [email] -r [repo url] -c [commit] --dir /etc/myappname --daemon yes > src/freedombone-app-myappname
53
+freedombone-template --app [name] -e [email] -r [repo url] \
54
+                     -c [commit] --dir /etc/myappname \
55
+                     --daemon yes > \
56
+                     src/freedombone-app-myappname
46 57
 #+end_src
47 58
 
48 59
 For more details see the manpage:

+ 25
- 14
website/EN/devguide.html Прегледај датотеку

@@ -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
-<!-- 2018-02-06 Tue 21:55 -->
6
+<!-- 2018-02-06 Tue 22:00 -->
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>&lrm;</title>
@@ -246,17 +246,17 @@ for the JavaScript code in this tag.
246 246
 
247 247
 <center><h1>Developers Guide</h1></center>
248 248
 
249
-<div id="outline-container-org178b393" class="outline-2">
250
-<h2 id="org178b393">Introduction</h2>
251
-<div class="outline-text-2" id="text-org178b393">
249
+<div id="outline-container-org5f276b0" class="outline-2">
250
+<h2 id="org5f276b0">Introduction</h2>
251
+<div class="outline-text-2" id="text-org5f276b0">
252 252
 <p>
253 253
 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. You might also want to consult the <a href="./codeofconduct.html">Code of Conduct</a>.
254 254
 </p>
255 255
 </div>
256 256
 </div>
257
-<div id="outline-container-org694dd79" class="outline-2">
258
-<h2 id="org694dd79">Adding extra apps</h2>
259
-<div class="outline-text-2" id="text-org694dd79">
257
+<div id="outline-container-orgc5287dc" class="outline-2">
258
+<h2 id="orgc5287dc">Adding extra apps</h2>
259
+<div class="outline-text-2" id="text-orgc5287dc">
260 260
 <p>
261 261
 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.
262 262
 </p>
@@ -270,7 +270,9 @@ To create a script for a generic PHP plus MySql/MariaDB web app:
270 270
 </p>
271 271
 
272 272
 <div class="org-src-container">
273
-<pre class="src src-bash">freedombone-template --app [name] -e [email] -r [repo url] -c [commit] --php yes -d mariadb &gt; src/freedombone-app-myappname
273
+<pre class="src src-bash">freedombone-template --app [name] -e [email] -r [repo url] <span class="org-sh-escaped-newline">\</span>
274
+                     -c [commit] --php yes -d mariadb &gt; <span class="org-sh-escaped-newline">\</span>
275
+                     src/freedombone-app-myappname
274 276
 </pre>
275 277
 </div>
276 278
 
@@ -279,7 +281,10 @@ For a Nodejs app with MySql/MariaDB database:
279 281
 </p>
280 282
 
281 283
 <div class="org-src-container">
282
-<pre class="src src-bash">freedombone-template --app [name] -e [email] -r [repo url] -c [commit] --node yes -d mariadb --dir /etc/myappname --daemon yes &gt; src/freedombone-app-myappname
284
+<pre class="src src-bash">freedombone-template --app [name] -e [email] -r [repo url] <span class="org-sh-escaped-newline">\</span>
285
+                     -c [commit] --node yes -d mariadb <span class="org-sh-escaped-newline">\</span>
286
+                     --dir /etc/myappname --daemon yes &gt; <span class="org-sh-escaped-newline">\</span>
287
+                     src/freedombone-app-myappname
283 288
 </pre>
284 289
 </div>
285 290
 
@@ -288,7 +293,10 @@ For a Python app with Postgresql database:
288 293
 </p>
289 294
 
290 295
 <div class="org-src-container">
291
-<pre class="src src-bash">freedombone-template --app [name] -e [email] -r [repo url] -c [commit] -d postgresql --dir /etc/myappname --daemon yes &gt; src/freedombone-app-myappname
296
+<pre class="src src-bash">freedombone-template --app [name] -e [email] -r [repo url] <span class="org-sh-escaped-newline">\</span>
297
+                     -c [commit] -d postgresql <span class="org-sh-escaped-newline">\</span>
298
+                     --dir /etc/myappname --daemon yes &gt; <span class="org-sh-escaped-newline">\</span>
299
+                     src/freedombone-app-myappname
292 300
 </pre>
293 301
 </div>
294 302
 
@@ -297,7 +305,10 @@ For a Python app without any database:
297 305
 </p>
298 306
 
299 307
 <div class="org-src-container">
300
-<pre class="src src-bash">freedombone-template --app [name] -e [email] -r [repo url] -c [commit] --dir /etc/myappname --daemon yes &gt; src/freedombone-app-myappname
308
+<pre class="src src-bash">freedombone-template --app [name] -e [email] -r [repo url] <span class="org-sh-escaped-newline">\</span>
309
+                     -c [commit] --dir /etc/myappname <span class="org-sh-escaped-newline">\</span>
310
+                     --daemon yes &gt; <span class="org-sh-escaped-newline">\</span>
311
+                     src/freedombone-app-myappname
301 312
 </pre>
302 313
 </div>
303 314
 
@@ -329,9 +340,9 @@ Submit your working app to <b><a href="https://github.com/bashrc/freedombone/iss
329 340
 </div>
330 341
 </div>
331 342
 
332
-<div id="outline-container-orge25d226" class="outline-2">
333
-<h2 id="orge25d226">Customising mesh images</h2>
334
-<div class="outline-text-2" id="text-orge25d226">
343
+<div id="outline-container-org088ee04" class="outline-2">
344
+<h2 id="org088ee04">Customising mesh images</h2>
345
+<div class="outline-text-2" id="text-org088ee04">
335 346
 <p>
336 347
 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.
337 348
 </p>