From a1c9ebe3e74dbd6d477a9b062927adcb7fa9cfc0 Mon Sep 17 00:00:00 2001 From: Denis Lehmann Date: Mon, 4 May 2020 19:56:37 +0200 Subject: [PATCH] add generation of README.md --- README.md | 38 ++++++++++++------------ raw/body.md | 65 ++++++++++++++++++++++++++++++++++++++++ raw/generate.sh | 9 ++++++ raw/header.md | 4 +++ raw/test.md | 79 +++++++++++++++++++++++++++++++++++++++++++++++++ 5 files changed, 176 insertions(+), 19 deletions(-) create mode 100644 raw/body.md create mode 100755 raw/generate.sh create mode 100644 raw/header.md create mode 100644 raw/test.md diff --git a/README.md b/README.md index 3c50ead..f5458bf 100644 --- a/README.md +++ b/README.md @@ -2,18 +2,18 @@ This is a collection of nice open source software. -- [Casual](#casual) - - [Office](#office) -- [Nerdy](#nerdy) - - [Package Managers](#package-managers) - - [Operating Systems](#operating-systems) - - [File Sharing / - Synchronisation](#file-sharing-synchronisation) - - [Writing](#writing) - - [Editors](#editors) - - [Search Engines](#search-engines) - - [Window Managers](#window-managers) - - [Web Browsers](#web-browsers) + - [Casual](#casual) + - [Office](#office) + - [File Synchronisation](#file-synchronisation) + - [Nerdy](#nerdy) + - [Package Managers](#package-managers) + - [Operating Systems](#operating-systems) + - [File Sharing](#file-sharing) + - [Writing](#writing) + - [Editors](#editors) + - [Search Engines](#search-engines) + - [Window Managers](#window-managers) + - [Web Browsers](#web-browsers) ## Casual @@ -22,6 +22,12 @@ This is a collection of nice open source software. - [**Libre Office**](https://libreoffice.org/) Free and powerful office suite +### File Synchronisation + + - [**Syncthing**](https://syncthing.net/) + Synchronizes files between two or more computers in real time, + safely protected from prying eyes + ## Nerdy ### Package Managers @@ -35,15 +41,11 @@ This is a collection of nice open source software. - [**NixOS**](https://nixos.org/) Declarative operating system, based on the **Nix** package manager -### File Sharing / Synchronisation +### File Sharing - [**Magic Wormhole**](https://github.com/warner/magic-wormhole/) Get things from one computer to another, safely - - [**Syncthing**](https://syncthing.net/) - Synchronizes files between two or more computers in real time, - safely protected from prying eyes - ### Writing - [**Pandoc**](https://pandoc.org/) @@ -65,7 +67,6 @@ This is a collection of nice open source software. - [**i3**](https://i3wm.org/) Improved tiling window manager - - [**i3-gaps**](https://github.com/Airblader/i3/) **i3** with more features @@ -73,6 +74,5 @@ This is a collection of nice open source software. - [**qutebrowser**](https://qutebrowser.org/) Keyboard-focused browser with a minimal GUI - - [**w3m**](http://w3m.sourceforge.net/) Text-based web browser as well as a pager diff --git a/raw/body.md b/raw/body.md new file mode 100644 index 0000000..5eea8c1 --- /dev/null +++ b/raw/body.md @@ -0,0 +1,65 @@ +Casual +------ + +### Office + +[**Libre Office**](https://libreoffice.org/) +: Free and powerful office suite + +### File Synchronisation + +[**Syncthing**](https://syncthing.net/) +: Synchronizes files between two or more computers in real time, + safely protected from prying eyes + +Nerdy +----- + +### Package Managers + +[**Nix**](https://nixos.org/nix/) +: Purely functional package manager, available for all Unix based + distributions + +### Operating Systems + +[**NixOS**](https://nixos.org/) +: Declarative operating system, based on the **Nix** package manager + +### File Sharing + +[**Magic Wormhole**](https://github.com/warner/magic-wormhole/) +: Get things from one computer to another, safely + +### Writing + +[**Pandoc**](https://pandoc.org/) +: Swiss-army knife for converting files from one markup format into + another + +### Editors + +[**Kakoune**](https://kakoune.org/) +: Modal editor, similar to Vim + +### Search Engines + +[**searx**](https://asciimoo.github.io/searx/) +: Searx is a free internet metasearch engine which aggregates results + from more than 70 search services + +### Window Managers + +[**i3**](https://i3wm.org/) +: Improved tiling window manager + +[**i3-gaps**](https://github.com/Airblader/i3/) +: **i3** with more features + +### Web Browsers + +[**qutebrowser**](https://qutebrowser.org/) +: Keyboard-focused browser with a minimal GUI + +[**w3m**](http://w3m.sourceforge.net/) +: Text-based web browser as well as a pager diff --git a/raw/generate.sh b/raw/generate.sh new file mode 100755 index 0000000..db4fa3c --- /dev/null +++ b/raw/generate.sh @@ -0,0 +1,9 @@ +#!/bin/sh + +# Cleanup files +pandoc header.md -o header.md +pandoc body.md -o body.md + +# Generate README.md +pandoc -H header.md --toc body.md -o ../README.md +pandoc -t gfm ../README.md -o ../README.md diff --git a/raw/header.md b/raw/header.md new file mode 100644 index 0000000..27032f4 --- /dev/null +++ b/raw/header.md @@ -0,0 +1,4 @@ +Links +===== + +This is a collection of nice open source software. diff --git a/raw/test.md b/raw/test.md new file mode 100644 index 0000000..8b8092b --- /dev/null +++ b/raw/test.md @@ -0,0 +1,79 @@ +# Links + +This is a collection of nice open source software. + +- [Casual](#casual) + - [Office](#office) +- [Nerdy](#nerdy) + - [Package Managers](#package-managers) + - [Operating Systems](#operating-systems) + - [File Sharing / Synchronisation](#file-sharing-synchronisation) + - [Writing](#writing) + - [Editors](#editors) + - [Search Engines](#search-engines) + - [Window Managers](#window-managers) + - [Web Browsers](#web-browsers) + +Casual +------ + +### Office + +- [**Libre Office**](https://libreoffice.org/)\ + Free and powerful office suite + +Nerdy +----- + +### Package Managers + +- [**Nix**](https://nixos.org/nix/)\ + Purely functional package manager, available for all Unix based + distributions + +### Operating Systems + +- [**NixOS**](https://nixos.org/)\ + Declarative operating system, based on the **Nix** package manager + +### File Sharing / Synchronisation + +- [**Magic Wormhole**](https://github.com/warner/magic-wormhole/)\ + Get things from one computer to another, safely + +- [**Syncthing**](https://syncthing.net/)\ + Synchronizes files between two or more computers in real time, + safely protected from prying eyes + +### Writing + +- [**Pandoc**](https://pandoc.org/)\ + Swiss-army knife for converting files from one markup format into + another + +### Editors + +- [**Kakoune**](https://kakoune.org/)\ + Modal editor, similar to Vim + +### Search Engines + +- [**searx**](https://asciimoo.github.io/searx/)\ + Searx is a free internet metasearch engine which aggregates results + from more than 70 search services + +### Window Managers + +- [**i3**](https://i3wm.org/)\ + Improved tiling window manager + +- [**i3-gaps**](https://github.com/Airblader/i3/)\ + **i3** with more features + +### Web Browsers + +- [**qutebrowser**](https://qutebrowser.org/)\ + Keyboard-focused browser with a minimal GUI + +- [**w3m**](http://w3m.sourceforge.net/)\ + Text-based web browser as well as a pager