[2/2] Add a README to folder tools.

Submitted by Robert Langhammer on Dec. 12, 2019, 7:19 p.m.

Details

Message ID 20191212191920.13820-2-rlanghammer@web.de
State Accepted
Headers show

Commit Message

Robert Langhammer Dec. 12, 2019, 7:19 p.m.
Signed-off-by: Robert Langhammer <rlanghammer@web.de>
---
 tools/README | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)
 create mode 100644 tools/README

--
2.20.1

Patch hide | download patch | download mbox

diff --git a/tools/README b/tools/README
new file mode 100644
index 0000000..2bcd54d
--- /dev/null
+++ b/tools/README
@@ -0,0 +1,25 @@ 
+  ____  ____  ____  _____
+ |     |     |        |   Freifunk
+ |____ |____ |____    |    Franken
+ |     |     |        |     Firmware
+ |     |     |        |      Tools
+
+In this folder you will find tools which can help you
+hacking and building the firmware.
+
+## buildscript-bash-completion
+
+Just source this script or put it in your /etc/bash_completion.d
+It provides all options and parameters of the buildscript on tab.
+
+
+## dep-tree
+
+This script collects all fff-package dependencies. You can throw the
+output at the graphviz dot-tool to visualize the dependecies-tree. e.g.
+dep-tree | dot -Tx11
+dep-tree | dot -Tpdf > dependencies.pdf
+
+
+
+

Comments

Fabian Blaese Dec. 14, 2019, 8:21 p.m.
Mehr Dokumentation, mehr gut.

Reviewed-by: Fabian Bläse <fabian@blaese.de>

On 12.12.19 20:19, Robert Langhammer wrote:
> Signed-off-by: Robert Langhammer <rlanghammer@web.de>
> ---
>  tools/README | 25 +++++++++++++++++++++++++
>  1 file changed, 25 insertions(+)
>  create mode 100644 tools/README
> 
> diff --git a/tools/README b/tools/README
> new file mode 100644
> index 0000000..2bcd54d
> --- /dev/null
> +++ b/tools/README
> @@ -0,0 +1,25 @@
> +  ____  ____  ____  _____
> + |     |     |        |   Freifunk
> + |____ |____ |____    |    Franken
> + |     |     |        |     Firmware
> + |     |     |        |      Tools
> +
> +In this folder you will find tools which can help you
> +hacking and building the firmware.
> +
> +## buildscript-bash-completion
> +
> +Just source this script or put it in your /etc/bash_completion.d
> +It provides all options and parameters of the buildscript on tab.
> +
> +
> +## dep-tree
> +
> +This script collects all fff-package dependencies. You can throw the
> +output at the graphviz dot-tool to visualize the dependecies-tree. e.g.
> +dep-tree | dot -Tx11
> +dep-tree | dot -Tpdf > dependencies.pdf
> +
> +
> +
> +
> --
> 2.20.1
>
Fabian Blaese Dec. 14, 2019, 8:23 p.m.
Was ich noch vergessen hab: Man sollte die Datei README.md nennen, ist ja schließlich Markdown..

Gruß
Fabian

On 12.12.19 20:19, Robert Langhammer wrote:
> Signed-off-by: Robert Langhammer <rlanghammer@web.de>
> ---
>  tools/README | 25 +++++++++++++++++++++++++
>  1 file changed, 25 insertions(+)
>  create mode 100644 tools/README
> 
> diff --git a/tools/README b/tools/README
> new file mode 100644
> index 0000000..2bcd54d
> --- /dev/null
> +++ b/tools/README
> @@ -0,0 +1,25 @@
> +  ____  ____  ____  _____
> + |     |     |        |   Freifunk
> + |____ |____ |____    |    Franken
> + |     |     |        |     Firmware
> + |     |     |        |      Tools
> +
> +In this folder you will find tools which can help you
> +hacking and building the firmware.
> +
> +## buildscript-bash-completion
> +
> +Just source this script or put it in your /etc/bash_completion.d
> +It provides all options and parameters of the buildscript on tab.
> +
> +
> +## dep-tree
> +
> +This script collects all fff-package dependencies. You can throw the
> +output at the graphviz dot-tool to visualize the dependecies-tree. e.g.
> +dep-tree | dot -Tx11
> +dep-tree | dot -Tpdf > dependencies.pdf
> +
> +
> +
> +
> --
> 2.20.1
>
Robert Langhammer Dec. 14, 2019, 9:20 p.m.
Jo, könnte man machen. Kannst du das beim Applien ändern?

Am 14.12.19 um 21:23 schrieb Fabian Bläse:
> Was ich noch vergessen hab: Man sollte die Datei README.md nennen, ist ja schließlich Markdown..
>
> Gruß
> Fabian
>
> On 12.12.19 20:19, Robert Langhammer wrote:
>> Signed-off-by: Robert Langhammer <rlanghammer@web.de>
>> ---
>>  tools/README | 25 +++++++++++++++++++++++++
>>  1 file changed, 25 insertions(+)
>>  create mode 100644 tools/README
>>
>> diff --git a/tools/README b/tools/README
>> new file mode 100644
>> index 0000000..2bcd54d
>> --- /dev/null
>> +++ b/tools/README
>> @@ -0,0 +1,25 @@
>> +  ____  ____  ____  _____
>> + |     |     |        |   Freifunk
>> + |____ |____ |____    |    Franken
>> + |     |     |        |     Firmware
>> + |     |     |        |      Tools
>> +
>> +In this folder you will find tools which can help you
>> +hacking and building the firmware.
>> +
>> +## buildscript-bash-completion
>> +
>> +Just source this script or put it in your /etc/bash_completion.d
>> +It provides all options and parameters of the buildscript on tab.
>> +
>> +
>> +## dep-tree
>> +
>> +This script collects all fff-package dependencies. You can throw the
>> +output at the graphviz dot-tool to visualize the dependecies-tree. e.g.
>> +dep-tree | dot -Tx11
>> +dep-tree | dot -Tpdf > dependencies.pdf
>> +
>> +
>> +
>> +
>> --
>> 2.20.1
>>
Fabian Blaese Dec. 24, 2019, 11:54 a.m.
Ich hab noch kleine Whitespace issues gefixt und Code Blöcke für die Commands hinzugefügt, damit diese im Markdown sinnvoll angezeigt werden.
Außerdem hab ich wie besprochen die Datei in README.md umbenannt.

applied.

Gruß
Fabian