diff --git a/doc/EN/devguide.org b/doc/EN/devguide.org index 1a5a2717..41f6874d 100644 --- a/doc/EN/devguide.org +++ b/doc/EN/devguide.org @@ -89,6 +89,16 @@ myappname_variables=(ONION_ONLY MYAPPNAME_ONION_PORT MYAPPNAME_DB_PASSWORD) +function logging_on_xmpp { + echo -n '' + # Commands to turn on logging go here +} + +function logging_off_xmpp { + echo -n '' + # Commands to turn off logging go here +} + function change_password_myappname { PASSWORD_USERNAME="$1" PASSWORD_NEW="$2" diff --git a/website/EN/devguide.html b/website/EN/devguide.html index 6f24be34..2307692f 100644 --- a/website/EN/devguide.html +++ b/website/EN/devguide.html @@ -3,7 +3,7 @@ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> - + @@ -71,6 +71,7 @@ pre.src-fortran:before { content: 'Fortran'; } pre.src-gnuplot:before { content: 'gnuplot'; } pre.src-haskell:before { content: 'Haskell'; } + pre.src-hledger:before { content: 'hledger'; } pre.src-java:before { content: 'Java'; } pre.src-js:before { content: 'Javascript'; } pre.src-latex:before { content: 'LaTeX'; } @@ -188,7 +189,7 @@ @licstart The following is the entire license notice for the JavaScript code in this tag. -Copyright (C) 2012-2013 Free Software Foundation, Inc. +Copyright (C) 2012-2017 Free Software Foundation, Inc. The JavaScript code in this tag is free software: you can redistribute it and/or modify it under the terms of the GNU @@ -245,17 +246,17 @@ for the JavaScript code in this tag.

Developers Guide

-
-

Introduction

-
+
+

Introduction

+

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.

-
-

Community Statement

-
+
+

Community Statement

+

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.

@@ -273,9 +274,9 @@ This project also has a no bullshit policy. Anyone trying to cause a ruckus by t

-
-

Adding extra apps

-
+
+

Adding extra apps

+

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.

@@ -285,8 +286,8 @@ On an installed system the app scripts go into the directory:

-
/usr/share/freedombone/apps
-
+
/usr/share/freedombone/apps
+

@@ -294,8 +295,8 @@ and within the project repo they appear within the src directory. Your ne

-
freedombone-app-[myappname]
-
+
freedombone-app-[myappname]
+

@@ -307,7 +308,7 @@ An example template for an app script is shown below. Copy this and add whatever

-
#!/bin/bash
+
#!/bin/bash
 # Copyright (C) Year YourName <YourEmail>
 #
 # This program is free software: you can redistribute it
@@ -352,6 +353,16 @@ An example template for an app script is shown below. Copy this and add whatever
                      MYAPPNAME_ONION_PORT
                      MYAPPNAME_DB_PASSWORD)
 
+function logging_on_xmpp {
+    echo -n ''
+    # Commands to turn on logging go here
+}
+
+function logging_off_xmpp {
+    echo -n ''
+    # Commands to turn off logging go here
+}
+
 function change_password_myappname {
     PASSWORD_USERNAME="$1"
     PASSWORD_NEW="$2"
@@ -508,7 +519,7 @@ An example template for an app script is shown below. Copy this and add whatever
 }
 
 # NOTE: deliberately no exit 0
-

+

@@ -516,8 +527,8 @@ To test your app log into your system, select Exit to command line then g

-
sudo su
-
+
sudo su
+

@@ -529,8 +540,8 @@ And run the admin control panel:

-
control
-
+
control
+

@@ -543,9 +554,9 @@ Submit your working app to -

Customising mesh images

-
+
+

Customising mesh images

+

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 img/backgrounds and to change the available avatars and desktop icons edit the images within img/avatars. Re-create disk images using the instructions shown previously.