free
/
freedombone
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Tidying on multiple lines

This commit is contained in:
Bob Mottram 2018-02-06 22:00:15 +00:00
parent 511a8c1683
commit 4abab0104a
2 changed files with 40 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
doc/EN/devguide.org
View File

@ -24,25 +24,36 @@ There's a command which you can use to generate scripts for new apps. Some examp
To create a script for a generic PHP plus MySql/MariaDB web app:
#+begin_src bash
freedombone-template --app [name] -e [email] -r [repo url] -c [commit] --php yes -d mariadb > src/freedombone-app-myappname
freedombone-template --app [name] -e [email] -r [repo url] \
-c [commit] --php yes -d mariadb > \
src/freedombone-app-myappname
#+end_src
For a Nodejs app with MySql/MariaDB database:
#+begin_src bash
freedombone-template --app [name] -e [email] -r [repo url] -c [commit] --node yes -d mariadb --dir /etc/myappname --daemon yes > src/freedombone-app-myappname
freedombone-template --app [name] -e [email] -r [repo url] \
-c [commit] --node yes -d mariadb \
--dir /etc/myappname --daemon yes > \
src/freedombone-app-myappname
#+end_src
For a Python app with Postgresql database:
#+begin_src bash
freedombone-template --app [name] -e [email] -r [repo url] -c [commit] -d postgresql --dir /etc/myappname --daemon yes > src/freedombone-app-myappname
freedombone-template --app [name] -e [email] -r [repo url] \
-c [commit] -d postgresql \
--dir /etc/myappname --daemon yes > \
src/freedombone-app-myappname
#+end_src
For a Python app without any database:
#+begin_src bash
freedombone-template --app [name] -e [email] -r [repo url] -c [commit] --dir /etc/myappname --daemon yes > src/freedombone-app-myappname
freedombone-template --app [name] -e [email] -r [repo url] \
-c [commit] --dir /etc/myappname \
--daemon yes > \
src/freedombone-app-myappname
#+end_src
For more details see the manpage:

39
website/EN/devguide.html
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>
<!-- 2018-02-06 Tue 21:55 -->
<!-- 2018-02-06 Tue 22:00 -->
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<title>&lrm;</title>
@ -246,17 +246,17 @@ for the JavaScript code in this tag.
<center><h1>Developers Guide</h1></center>
<div id="outline-container-org178b393" class="outline-2">
<h2 id="org178b393">Introduction</h2>
<div class="outline-text-2" id="text-org178b393">
<div id="outline-container-org5f276b0" class="outline-2">
<h2 id="org5f276b0">Introduction</h2>
<div class="outline-text-2" id="text-org5f276b0">
<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. You might also want to consult the <a href="./codeofconduct.html">Code of Conduct</a>.
</p>
</div>
</div>
<div id="outline-container-org694dd79" class="outline-2">
<h2 id="org694dd79">Adding extra apps</h2>
<div class="outline-text-2" id="text-org694dd79">
<div id="outline-container-orgc5287dc" class="outline-2">
<h2 id="orgc5287dc">Adding extra apps</h2>
<div class="outline-text-2" id="text-orgc5287dc">
<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>
@ -270,7 +270,9 @@ To create a script for a generic PHP plus MySql/MariaDB web app:
</p>
<div class="org-src-container">
<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
<pre class="src src-bash">freedombone-template --app [name] -e [email] -r [repo url] <span class="org-sh-escaped-newline">\</span>
-c [commit] --php yes -d mariadb &gt; <span class="org-sh-escaped-newline">\</span>
src/freedombone-app-myappname
</pre>
</div>
@ -279,7 +281,10 @@ For a Nodejs app with MySql/MariaDB database:
</p>
<div class="org-src-container">
<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
<pre class="src src-bash">freedombone-template --app [name] -e [email] -r [repo url] <span class="org-sh-escaped-newline">\</span>
-c [commit] --node yes -d mariadb <span class="org-sh-escaped-newline">\</span>
--dir /etc/myappname --daemon yes &gt; <span class="org-sh-escaped-newline">\</span>
src/freedombone-app-myappname
</pre>
</div>
@ -288,7 +293,10 @@ For a Python app with Postgresql database:
</p>
<div class="org-src-container">
<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
<pre class="src src-bash">freedombone-template --app [name] -e [email] -r [repo url] <span class="org-sh-escaped-newline">\</span>
-c [commit] -d postgresql <span class="org-sh-escaped-newline">\</span>
--dir /etc/myappname --daemon yes &gt; <span class="org-sh-escaped-newline">\</span>
src/freedombone-app-myappname
</pre>
</div>
@ -297,7 +305,10 @@ For a Python app without any database:
</p>
<div class="org-src-container">
<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
<pre class="src src-bash">freedombone-template --app [name] -e [email] -r [repo url] <span class="org-sh-escaped-newline">\</span>
-c [commit] --dir /etc/myappname <span class="org-sh-escaped-newline">\</span>
--daemon yes &gt; <span class="org-sh-escaped-newline">\</span>
src/freedombone-app-myappname
</pre>
</div>
@ -329,9 +340,9 @@ Submit your working app to <b><a href="https://github.com/bashrc/freedombone/iss
</div>
</div>
<div id="outline-container-orge25d226" class="outline-2">
<h2 id="orge25d226">Customising mesh images</h2>
<div class="outline-text-2" id="text-orge25d226">
<div id="outline-container-org088ee04" class="outline-2">
<h2 id="org088ee04">Customising mesh images</h2>
<div class="outline-text-2" id="text-org088ee04">
<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>