CoC documentation on website
This commit is contained in:
Bob Mottram
parent
0dd760e905
commit
0f8615abe1
|
|
@ -0,0 +1,49 @@
|
|||
#+TITLE:
|
||||
#+AUTHOR: Bob Mottram
|
||||
#+EMAIL: bob@freedombone.net
|
||||
#+KEYWORDS: freedombone, code of conduct
|
||||
#+DESCRIPTION: Code of Conduct for the Freedombone project
|
||||
#+OPTIONS: ^:nil toc:nil
|
||||
#+HTML_HEAD: <link rel="stylesheet" type="text/css" href="freedombone.css" />
|
||||
|
||||
#+BEGIN_CENTER
|
||||
[[file:images/logo.png]]
|
||||
#+END_CENTER
|
||||
|
||||
#+begin_export html
|
||||
<center><h1>Code of Conduct</h1></center>
|
||||
#+end_export
|
||||
|
||||
* Be respectful
|
||||
|
||||
In any Free Software project with more than one participant inevitably there may be people with whom you may disagree, or find it difficult to cooperate. Accept that, but even so, remain respectful. Disagreement is no excuse for poor behaviour or personal attacks, and a community in which people feel threatened is not a healthy community.
|
||||
|
||||
* Assume good faith
|
||||
|
||||
Freedombone Contributors have many ways of reaching our common goal of providing freedom respecting internet or mesh systems which may differ from your ways. Assume that other people are working towards this goal.
|
||||
|
||||
* Be collaborative
|
||||
|
||||
Freedombone is a moderately complex project, though nothing big and professional like GNU. It's good to ask for help when you need it. Similarly, offers for help should be seen in the context of our shared goal of improving the system.
|
||||
|
||||
When you make something for the benefit of the project, be willing to explain to others how it works, so that they can build on your work to make it even better.
|
||||
|
||||
* Try to be concise
|
||||
|
||||
If you're submitting documentation then keep in mind that what you write once could be read by many other people. To avoid TL;DR keep it as short and concise as possible. This will also reduce the amount of translations effort needed.
|
||||
|
||||
If you're discussing an issue or bug, try to stay on topic, especially in discussions that are already fairly large.
|
||||
|
||||
* Be open
|
||||
|
||||
Most ways of communication used within Freedombone (eg Matrix/XMPP) allow for public and private communication. Prefer public methods of communication for Freedombone-related messages, unless posting something sensitive.
|
||||
|
||||
This applies to messages for help, too; not only is a public support request much more likely to result in an answer to your question, it also makes sure that any inadvertent mistakes made by people answering your question will be more easily detected and corrected.
|
||||
|
||||
* In case of problems
|
||||
|
||||
While this code of conduct should be adhered to by participants, we recognize that sometimes people may have a bad day, or be unaware of some of the guidelines in this code of conduct. When that happens, you may reply to them and point out this code of conduct. Such messages may be in public or in private, whatever is most appropriate. However, regardless of whether the message is public or not, it should still adhere to the relevant parts of this code of conduct; in particular, it should not be abusive or disrespectful. Assume good faith; it is more likely that participants are unaware of their bad behaviour than that they intentionally try to degrade the quality of the discussion.
|
||||
|
||||
Serious or persistent offenders will be kicked from chat rooms and any of their subsequent patches will be unlikely to be upstreamed.
|
||||
|
||||
Complaints should be made (in private) to the maintainer or chat room admin. The typical email address can be found in the source code headers. Preferably use GPG/OpenPGP if you can, or XMPP with OTR/OMEMO to bob@freedombone.net.
|
||||
|
|
@ -15,20 +15,7 @@
|
|||
#+end_export
|
||||
|
||||
* 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.
|
||||
* Substitute for a Code of Conduct
|
||||
Instead of having some tedious /Code of Conduct/ which tries to micro-manage how folks communicate privately with each other this project has a set of guiding principles, which are as follows:
|
||||
|
||||
* Enable users to help themselves to provide their own personal software infrastructure.
|
||||
* Enable users to help each other to provide software infrastructure for a community.
|
||||
* Principle of self-management: apps should require miniumum configuration and maintain themselves as far as possible.
|
||||
* There should be no single point of failure. Assume that other servers can and will fail occasionally.
|
||||
* Minimum data retention. Only store the data which users actually want or need, and within apps implement the function which allows logging to be turned off.
|
||||
* Respect other users right to run their own stuff and have their own policies on their own hardware.
|
||||
* Remove as many intermediating organisations as possible. For example, Google tracking embedded within some Free Software apps.
|
||||
* No tollbooths, rent-seeking, gatekeepers or paywalls.
|
||||
* Maximize energy efficiency. No systems which fundamentally depend upon proof-of-work block solving or other compute-heavy methods. The target here is small single board computers.
|
||||
|
||||
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 [[./codeofconduct.html][Code of Conduct]].
|
||||
* 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.
|
||||
|
||||
|
|
|
|||
|
|
@ -37,7 +37,7 @@ After installation it's possible that you might want some advice on how to run y
|
|||
* [[./faq.html][Frequently Asked Questions]]
|
||||
* [[./mobile.html][Advice on setting up a mobile phone]]
|
||||
|
||||
If you find bugs, or want to add a new app to this system see the [[./devguide.html][Developers Guide]].
|
||||
If you find bugs, or want to add a new app to this system see the [[./devguide.html][Developers Guide]] and [[./codeofconduct.html][Code of Conduct]].
|
||||
|
||||
Ready made disk images which can be copied onto USB or microSD drives are [[./downloads/current][available here]].
|
||||
|
||||
|
|
|
|||
|
|
@ -0,0 +1,348 @@
|
|||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
|
||||
<head>
|
||||
<!-- 2017-12-20 Wed 12:45 -->
|
||||
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1" />
|
||||
<title>‎</title>
|
||||
<meta name="generator" content="Org mode" />
|
||||
<meta name="author" content="Bob Mottram" />
|
||||
<meta name="description" content="Code of Conduct for the Freedombone project"
|
||||
/>
|
||||
<meta name="keywords" content="freedombone, code of conduct" />
|
||||
<style type="text/css">
|
||||
<!--/*--><![CDATA[/*><!--*/
|
||||
.title { text-align: center;
|
||||
margin-bottom: .2em; }
|
||||
.subtitle { text-align: center;
|
||||
font-size: medium;
|
||||
font-weight: bold;
|
||||
margin-top:0; }
|
||||
.todo { font-family: monospace; color: red; }
|
||||
.done { font-family: monospace; color: green; }
|
||||
.priority { font-family: monospace; color: orange; }
|
||||
.tag { background-color: #eee; font-family: monospace;
|
||||
padding: 2px; font-size: 80%; font-weight: normal; }
|
||||
.timestamp { color: #bebebe; }
|
||||
.timestamp-kwd { color: #5f9ea0; }
|
||||
.org-right { margin-left: auto; margin-right: 0px; text-align: right; }
|
||||
.org-left { margin-left: 0px; margin-right: auto; text-align: left; }
|
||||
.org-center { margin-left: auto; margin-right: auto; text-align: center; }
|
||||
.underline { text-decoration: underline; }
|
||||
#postamble p, #preamble p { font-size: 90%; margin: .2em; }
|
||||
p.verse { margin-left: 3%; }
|
||||
pre {
|
||||
border: 1px solid #ccc;
|
||||
box-shadow: 3px 3px 3px #eee;
|
||||
padding: 8pt;
|
||||
font-family: monospace;
|
||||
overflow: auto;
|
||||
margin: 1.2em;
|
||||
}
|
||||
pre.src {
|
||||
position: relative;
|
||||
overflow: visible;
|
||||
padding-top: 1.2em;
|
||||
}
|
||||
pre.src:before {
|
||||
display: none;
|
||||
position: absolute;
|
||||
background-color: white;
|
||||
top: -10px;
|
||||
right: 10px;
|
||||
padding: 3px;
|
||||
border: 1px solid black;
|
||||
}
|
||||
pre.src:hover:before { display: inline;}
|
||||
/* Languages per Org manual */
|
||||
pre.src-asymptote:before { content: 'Asymptote'; }
|
||||
pre.src-awk:before { content: 'Awk'; }
|
||||
pre.src-C:before { content: 'C'; }
|
||||
/* pre.src-C++ doesn't work in CSS */
|
||||
pre.src-clojure:before { content: 'Clojure'; }
|
||||
pre.src-css:before { content: 'CSS'; }
|
||||
pre.src-D:before { content: 'D'; }
|
||||
pre.src-ditaa:before { content: 'ditaa'; }
|
||||
pre.src-dot:before { content: 'Graphviz'; }
|
||||
pre.src-calc:before { content: 'Emacs Calc'; }
|
||||
pre.src-emacs-lisp:before { content: 'Emacs Lisp'; }
|
||||
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'; }
|
||||
pre.src-ledger:before { content: 'Ledger'; }
|
||||
pre.src-lisp:before { content: 'Lisp'; }
|
||||
pre.src-lilypond:before { content: 'Lilypond'; }
|
||||
pre.src-lua:before { content: 'Lua'; }
|
||||
pre.src-matlab:before { content: 'MATLAB'; }
|
||||
pre.src-mscgen:before { content: 'Mscgen'; }
|
||||
pre.src-ocaml:before { content: 'Objective Caml'; }
|
||||
pre.src-octave:before { content: 'Octave'; }
|
||||
pre.src-org:before { content: 'Org mode'; }
|
||||
pre.src-oz:before { content: 'OZ'; }
|
||||
pre.src-plantuml:before { content: 'Plantuml'; }
|
||||
pre.src-processing:before { content: 'Processing.js'; }
|
||||
pre.src-python:before { content: 'Python'; }
|
||||
pre.src-R:before { content: 'R'; }
|
||||
pre.src-ruby:before { content: 'Ruby'; }
|
||||
pre.src-sass:before { content: 'Sass'; }
|
||||
pre.src-scheme:before { content: 'Scheme'; }
|
||||
pre.src-screen:before { content: 'Gnu Screen'; }
|
||||
pre.src-sed:before { content: 'Sed'; }
|
||||
pre.src-sh:before { content: 'shell'; }
|
||||
pre.src-sql:before { content: 'SQL'; }
|
||||
pre.src-sqlite:before { content: 'SQLite'; }
|
||||
/* additional languages in org.el's org-babel-load-languages alist */
|
||||
pre.src-forth:before { content: 'Forth'; }
|
||||
pre.src-io:before { content: 'IO'; }
|
||||
pre.src-J:before { content: 'J'; }
|
||||
pre.src-makefile:before { content: 'Makefile'; }
|
||||
pre.src-maxima:before { content: 'Maxima'; }
|
||||
pre.src-perl:before { content: 'Perl'; }
|
||||
pre.src-picolisp:before { content: 'Pico Lisp'; }
|
||||
pre.src-scala:before { content: 'Scala'; }
|
||||
pre.src-shell:before { content: 'Shell Script'; }
|
||||
pre.src-ebnf2ps:before { content: 'ebfn2ps'; }
|
||||
/* additional language identifiers per "defun org-babel-execute"
|
||||
in ob-*.el */
|
||||
pre.src-cpp:before { content: 'C++'; }
|
||||
pre.src-abc:before { content: 'ABC'; }
|
||||
pre.src-coq:before { content: 'Coq'; }
|
||||
pre.src-groovy:before { content: 'Groovy'; }
|
||||
/* additional language identifiers from org-babel-shell-names in
|
||||
ob-shell.el: ob-shell is the only babel language using a lambda to put
|
||||
the execution function name together. */
|
||||
pre.src-bash:before { content: 'bash'; }
|
||||
pre.src-csh:before { content: 'csh'; }
|
||||
pre.src-ash:before { content: 'ash'; }
|
||||
pre.src-dash:before { content: 'dash'; }
|
||||
pre.src-ksh:before { content: 'ksh'; }
|
||||
pre.src-mksh:before { content: 'mksh'; }
|
||||
pre.src-posh:before { content: 'posh'; }
|
||||
/* Additional Emacs modes also supported by the LaTeX listings package */
|
||||
pre.src-ada:before { content: 'Ada'; }
|
||||
pre.src-asm:before { content: 'Assembler'; }
|
||||
pre.src-caml:before { content: 'Caml'; }
|
||||
pre.src-delphi:before { content: 'Delphi'; }
|
||||
pre.src-html:before { content: 'HTML'; }
|
||||
pre.src-idl:before { content: 'IDL'; }
|
||||
pre.src-mercury:before { content: 'Mercury'; }
|
||||
pre.src-metapost:before { content: 'MetaPost'; }
|
||||
pre.src-modula-2:before { content: 'Modula-2'; }
|
||||
pre.src-pascal:before { content: 'Pascal'; }
|
||||
pre.src-ps:before { content: 'PostScript'; }
|
||||
pre.src-prolog:before { content: 'Prolog'; }
|
||||
pre.src-simula:before { content: 'Simula'; }
|
||||
pre.src-tcl:before { content: 'tcl'; }
|
||||
pre.src-tex:before { content: 'TeX'; }
|
||||
pre.src-plain-tex:before { content: 'Plain TeX'; }
|
||||
pre.src-verilog:before { content: 'Verilog'; }
|
||||
pre.src-vhdl:before { content: 'VHDL'; }
|
||||
pre.src-xml:before { content: 'XML'; }
|
||||
pre.src-nxml:before { content: 'XML'; }
|
||||
/* add a generic configuration mode; LaTeX export needs an additional
|
||||
(add-to-list 'org-latex-listings-langs '(conf " ")) in .emacs */
|
||||
pre.src-conf:before { content: 'Configuration File'; }
|
||||
|
||||
table { border-collapse:collapse; }
|
||||
caption.t-above { caption-side: top; }
|
||||
caption.t-bottom { caption-side: bottom; }
|
||||
td, th { vertical-align:top; }
|
||||
th.org-right { text-align: center; }
|
||||
th.org-left { text-align: center; }
|
||||
th.org-center { text-align: center; }
|
||||
td.org-right { text-align: right; }
|
||||
td.org-left { text-align: left; }
|
||||
td.org-center { text-align: center; }
|
||||
dt { font-weight: bold; }
|
||||
.footpara { display: inline; }
|
||||
.footdef { margin-bottom: 1em; }
|
||||
.figure { padding: 1em; }
|
||||
.figure p { text-align: center; }
|
||||
.inlinetask {
|
||||
padding: 10px;
|
||||
border: 2px solid gray;
|
||||
margin: 10px;
|
||||
background: #ffffcc;
|
||||
}
|
||||
#org-div-home-and-up
|
||||
{ text-align: right; font-size: 70%; white-space: nowrap; }
|
||||
textarea { overflow-x: auto; }
|
||||
.linenr { font-size: smaller }
|
||||
.code-highlighted { background-color: #ffff00; }
|
||||
.org-info-js_info-navigation { border-style: none; }
|
||||
#org-info-js_console-label
|
||||
{ font-size: 10px; font-weight: bold; white-space: nowrap; }
|
||||
.org-info-js_search-highlight
|
||||
{ background-color: #ffff00; color: #000000; font-weight: bold; }
|
||||
.org-svg { width: 90%; }
|
||||
/*]]>*/-->
|
||||
</style>
|
||||
<link rel="stylesheet" type="text/css" href="freedombone.css" />
|
||||
<script type="text/javascript">
|
||||
/*
|
||||
@licstart The following is the entire license notice for the
|
||||
JavaScript code in this tag.
|
||||
|
||||
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
|
||||
General Public License (GNU GPL) as published by the Free Software
|
||||
Foundation, either version 3 of the License, or (at your option)
|
||||
any later version. The code is distributed WITHOUT ANY WARRANTY;
|
||||
without even the implied warranty of MERCHANTABILITY or FITNESS
|
||||
FOR A PARTICULAR PURPOSE. See the GNU GPL for more details.
|
||||
|
||||
As additional permission under GNU GPL version 3 section 7, you
|
||||
may distribute non-source (e.g., minimized or compacted) forms of
|
||||
that code without the copy of the GNU GPL normally required by
|
||||
section 4, provided you include this license notice and a URL
|
||||
through which recipients can access the Corresponding Source.
|
||||
|
||||
|
||||
@licend The above is the entire license notice
|
||||
for the JavaScript code in this tag.
|
||||
*/
|
||||
<!--/*--><![CDATA[/*><!--*/
|
||||
function CodeHighlightOn(elem, id)
|
||||
{
|
||||
var target = document.getElementById(id);
|
||||
if(null != target) {
|
||||
elem.cacheClassElem = elem.className;
|
||||
elem.cacheClassTarget = target.className;
|
||||
target.className = "code-highlighted";
|
||||
elem.className = "code-highlighted";
|
||||
}
|
||||
}
|
||||
function CodeHighlightOff(elem, id)
|
||||
{
|
||||
var target = document.getElementById(id);
|
||||
if(elem.cacheClassElem)
|
||||
elem.className = elem.cacheClassElem;
|
||||
if(elem.cacheClassTarget)
|
||||
target.className = elem.cacheClassTarget;
|
||||
}
|
||||
/*]]>*///-->
|
||||
</script>
|
||||
</head>
|
||||
<body>
|
||||
<div id="preamble" class="status">
|
||||
<a name="top" id="top"></a>
|
||||
</div>
|
||||
<div id="content">
|
||||
<div class="org-center">
|
||||
|
||||
<div class="figure">
|
||||
<p><img src="images/logo.png" alt="logo.png" />
|
||||
</p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<center><h1>Code of Conduct</h1></center>
|
||||
|
||||
<div id="outline-container-orga839710" class="outline-2">
|
||||
<h2 id="orga839710">Be respectful</h2>
|
||||
<div class="outline-text-2" id="text-orga839710">
|
||||
<p>
|
||||
In any Free Software project with more than one participant inevitably there may be people with whom you may disagree, or find it difficult to cooperate. Accept that, but even so, remain respectful. Disagreement is no excuse for poor behaviour or personal attacks, and a community in which people feel threatened is not a healthy community.
|
||||
</p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-org890f143" class="outline-2">
|
||||
<h2 id="org890f143">Assume good faith</h2>
|
||||
<div class="outline-text-2" id="text-org890f143">
|
||||
<p>
|
||||
Freedombone Contributors have many ways of reaching our common goal of providing freedom respecting internet or mesh systems which may differ from your ways. Assume that other people are working towards this goal.
|
||||
</p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-orgccafefb" class="outline-2">
|
||||
<h2 id="orgccafefb">Be collaborative</h2>
|
||||
<div class="outline-text-2" id="text-orgccafefb">
|
||||
<p>
|
||||
Freedombone is a moderately complex project, though nothing big and professional like GNU. It's good to ask for help when you need it. Similarly, offers for help should be seen in the context of our shared goal of improving the system.
|
||||
</p>
|
||||
|
||||
<p>
|
||||
When you make something for the benefit of the project, be willing to explain to others how it works, so that they can build on your work to make it even better.
|
||||
</p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-org960241b" class="outline-2">
|
||||
<h2 id="org960241b">Try to be concise</h2>
|
||||
<div class="outline-text-2" id="text-org960241b">
|
||||
<p>
|
||||
If you're submitting documentation then keep in mind that what you write once could be read by many other people. To avoid TL;DR keep it as short and concise as possible. This will also reduce the amount of translations effort needed.
|
||||
</p>
|
||||
|
||||
<p>
|
||||
If you're discussing an issue or bug, try to stay on topic, especially in discussions that are already fairly large.
|
||||
</p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-orgd3249bd" class="outline-2">
|
||||
<h2 id="orgd3249bd">Be open</h2>
|
||||
<div class="outline-text-2" id="text-orgd3249bd">
|
||||
<p>
|
||||
Most ways of communication used within Freedombone (eg Matrix/XMPP) allow for public and private communication. Prefer public methods of communication for Freedombone-related messages, unless posting something sensitive.
|
||||
</p>
|
||||
|
||||
<p>
|
||||
This applies to messages for help, too; not only is a public support request much more likely to result in an answer to your question, it also makes sure that any inadvertent mistakes made by people answering your question will be more easily detected and corrected.
|
||||
</p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-org8f9612f" class="outline-2">
|
||||
<h2 id="org8f9612f">In case of problems</h2>
|
||||
<div class="outline-text-2" id="text-org8f9612f">
|
||||
<p>
|
||||
While this code of conduct should be adhered to by participants, we recognize that sometimes people may have a bad day, or be unaware of some of the guidelines in this code of conduct. When that happens, you may reply to them and point out this code of conduct. Such messages may be in public or in private, whatever is most appropriate. However, regardless of whether the message is public or not, it should still adhere to the relevant parts of this code of conduct; in particular, it should not be abusive or disrespectful. Assume good faith; it is more likely that participants are unaware of their bad behaviour than that they intentionally try to degrade the quality of the discussion.
|
||||
</p>
|
||||
|
||||
<p>
|
||||
Serious or persistent offenders will be kicked from chat rooms and any of their subsequent patches will be unlikely to be upstreamed.
|
||||
</p>
|
||||
|
||||
<p>
|
||||
Complaints should be made (in private) to the maintainer or chat room admin. The typical email address can be found in the source code headers. Preferably use GPG/OpenPGP if you can, or XMPP with OTR/OMEMO to bob@freedombone.net.
|
||||
</p>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div id="postamble" class="status">
|
||||
|
||||
<style type="text/css">
|
||||
.back-to-top {
|
||||
position: fixed;
|
||||
bottom: 2em;
|
||||
right: 0px;
|
||||
text-decoration: none;
|
||||
color: #000000;
|
||||
background-color: rgba(235, 235, 235, 0.80);
|
||||
font-size: 12px;
|
||||
padding: 1em;
|
||||
display: none;
|
||||
}
|
||||
|
||||
.back-to-top:hover {
|
||||
background-color: rgba(135, 135, 135, 0.50);
|
||||
}
|
||||
</style>
|
||||
|
||||
<div class="back-to-top">
|
||||
<a href="#top">Back to top</a> | <a href="mailto:bob@freedombone.net">E-mail me</a>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -3,10 +3,10 @@
|
|||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
|
||||
<head>
|
||||
<!-- 2017-07-18 Tue 11:19 -->
|
||||
<!-- 2017-12-20 Wed 12:42 -->
|
||||
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1" />
|
||||
<title></title>
|
||||
<title>‎</title>
|
||||
<meta name="generator" content="Org mode" />
|
||||
<meta name="author" content="Bob Mottram" />
|
||||
<meta name="description" content="Turn the Beaglebone Black into a personal communications server"
|
||||
|
|
@ -246,38 +246,17 @@ for the JavaScript code in this tag.
|
|||
|
||||
<center><h1>Developers Guide</h1></center>
|
||||
|
||||
<div id="outline-container-orgeb19df0" class="outline-2">
|
||||
<h2 id="orgeb19df0">Introduction</h2>
|
||||
<div class="outline-text-2" id="text-orgeb19df0">
|
||||
<div id="outline-container-org6818d03" class="outline-2">
|
||||
<h2 id="org6818d03">Introduction</h2>
|
||||
<div class="outline-text-2" id="text-org6818d03">
|
||||
<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.
|
||||
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-org70ef738" class="outline-2">
|
||||
<h2 id="org70ef738">Substitute for a Code of Conduct</h2>
|
||||
<div class="outline-text-2" id="text-org70ef738">
|
||||
<p>
|
||||
Instead of having some tedious <i>Code of Conduct</i> which tries to micro-manage how folks communicate privately with each other this project has a set of guiding principles, which are as follows:
|
||||
</p>
|
||||
|
||||
<ul class="org-ul">
|
||||
<li>Enable users to help themselves to provide their own personal software infrastructure.</li>
|
||||
<li>Enable users to help each other to provide software infrastructure for a community.</li>
|
||||
<li>Principle of self-management: apps should require miniumum configuration and maintain themselves as far as possible.</li>
|
||||
<li>There should be no single point of failure. Assume that other servers can and will fail occasionally.</li>
|
||||
<li>Minimum data retention. Only store the data which users actually want or need, and within apps implement the function which allows logging to be turned off.</li>
|
||||
<li>Respect other users right to run their own stuff and have their own policies on their own hardware.</li>
|
||||
<li>Remove as many intermediating organisations as possible. For example, Google tracking embedded within some Free Software apps.</li>
|
||||
<li>No tollbooths, rent-seeking, gatekeepers or paywalls.</li>
|
||||
<li>Maximize energy efficiency. No systems which fundamentally depend upon proof-of-work block solving or other compute-heavy methods. The target here is small single board computers.</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-orgce166ed" class="outline-2">
|
||||
<h2 id="orgce166ed">Adding extra apps</h2>
|
||||
<div class="outline-text-2" id="text-orgce166ed">
|
||||
<div id="outline-container-org080672c" class="outline-2">
|
||||
<h2 id="org080672c">Adding extra apps</h2>
|
||||
<div class="outline-text-2" id="text-org080672c">
|
||||
<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>
|
||||
|
|
@ -287,8 +266,8 @@ On an installed system the app scripts go into the directory:
|
|||
</p>
|
||||
|
||||
<div class="org-src-container">
|
||||
<pre><code class="src src-bash">/usr/share/freedombone/apps
|
||||
</code></pre>
|
||||
<pre class="src src-bash">/usr/share/freedombone/apps
|
||||
</pre>
|
||||
</div>
|
||||
|
||||
<p>
|
||||
|
|
@ -296,8 +275,8 @@ and within the project repo they appear within the <i>src</i> directory. Your ne
|
|||
</p>
|
||||
|
||||
<div class="org-src-container">
|
||||
<pre><code class="src src-bash">freedombone-app-[myappname]
|
||||
</code></pre>
|
||||
<pre class="src src-bash">freedombone-app-[myappname]
|
||||
</pre>
|
||||
</div>
|
||||
|
||||
<p>
|
||||
|
|
@ -309,7 +288,7 @@ An example template for an app script is shown below. Copy this and add whatever
|
|||
</p>
|
||||
|
||||
<div class="org-src-container">
|
||||
<pre><code class="src src-bash"><span class="org-comment-delimiter">#</span><span class="org-comment">!/bin/</span><span class="org-keyword">bash</span>
|
||||
<pre class="src src-bash"><span class="org-comment-delimiter">#</span><span class="org-comment">!/bin/</span><span class="org-keyword">bash</span>
|
||||
<span class="org-comment-delimiter"># </span><span class="org-comment">Copyright (C) Year YourName <YourEmail></span>
|
||||
<span class="org-comment-delimiter">#</span>
|
||||
<span class="org-comment-delimiter"># </span><span class="org-comment">This program is free software: you can redistribute it</span>
|
||||
|
|
@ -520,7 +499,7 @@ 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">NOTE: deliberately no exit 0</span>
|
||||
</code></pre>
|
||||
</pre>
|
||||
</div>
|
||||
|
||||
<p>
|
||||
|
|
@ -528,8 +507,8 @@ To test your app log into your system, select <b>Exit to command line</b> then g
|
|||
</p>
|
||||
|
||||
<div class="org-src-container">
|
||||
<pre><code class="src src-bash">sudo su
|
||||
</code></pre>
|
||||
<pre class="src src-bash">sudo su
|
||||
</pre>
|
||||
</div>
|
||||
|
||||
<p>
|
||||
|
|
@ -541,8 +520,8 @@ And run the admin control panel:
|
|||
</p>
|
||||
|
||||
<div class="org-src-container">
|
||||
<pre><code class="src src-bash">control
|
||||
</code></pre>
|
||||
<pre class="src src-bash">control
|
||||
</pre>
|
||||
</div>
|
||||
|
||||
<p>
|
||||
|
|
@ -555,9 +534,9 @@ Submit your working app to <b><a href="https://github.com/bashrc/freedombone/iss
|
|||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-org2e7b384" class="outline-2">
|
||||
<h2 id="org2e7b384">Customising mesh images</h2>
|
||||
<div class="outline-text-2" id="text-org2e7b384">
|
||||
<div id="outline-container-orge29cd52" class="outline-2">
|
||||
<h2 id="orge29cd52">Customising mesh images</h2>
|
||||
<div class="outline-text-2" id="text-orge29cd52">
|
||||
<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>
|
||||
|
|
|
|||
|
|
@ -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>
|
||||
<!-- 2017-11-27 Mon 13:21 -->
|
||||
<!-- 2017-12-20 Wed 12:40 -->
|
||||
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1" />
|
||||
<title>‎</title>
|
||||
|
|
@ -290,7 +290,7 @@ After installation it's possible that you might want some advice on how to run y
|
|||
</ul>
|
||||
|
||||
<p>
|
||||
If you find bugs, or want to add a new app to this system see the <a href="./devguide.html">Developers Guide</a>.
|
||||
If you find bugs, or want to add a new app to this system see the <a href="./devguide.html">Developers Guide</a> and <a href="./codeofconduct.html">Code of Conduct</a>.
|
||||
</p>
|
||||
|
||||
<p>
|
||||
|
|
|
|||
Loading…
Reference in New Issue