added template README.md to root
This commit is contained in:
@@ -0,0 +1,83 @@
|
|||||||
|
# <scriptname>
|
||||||
|
|
||||||
|
Kurzbeschreibung des Skripts:
|
||||||
|
<eine Zeile, wofür es gedacht ist>
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Features
|
||||||
|
|
||||||
|
- Punkt 1
|
||||||
|
- Punkt 2
|
||||||
|
- Punkt 3
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
|
||||||
|
1. Repository klonen oder Skript kopieren:
|
||||||
|
```bash
|
||||||
|
git clone <gitea-url>/esn-support-bash-snippets.git
|
||||||
|
cd esn-support-bash-snippets/<legacy|wh20>/<scriptname>
|
||||||
|
chmod +x <scriptname>
|
||||||
|
```
|
||||||
|
|
||||||
|
2. Abhängigkeiten (falls vorhanden) installieren:
|
||||||
|
- `jq` (optional)
|
||||||
|
- weitere Tools
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Nutzung
|
||||||
|
|
||||||
|
### Standardaufruf
|
||||||
|
```bash
|
||||||
|
./<scriptname>
|
||||||
|
```
|
||||||
|
|
||||||
|
### Beispiele
|
||||||
|
```bash
|
||||||
|
./<scriptname> --option foo
|
||||||
|
./<scriptname> 2025-09-08
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Optionen
|
||||||
|
|
||||||
|
```
|
||||||
|
Usage: ./<scriptname> [OPTIONS]
|
||||||
|
|
||||||
|
--help Zeigt diese Hilfe
|
||||||
|
--option Beispieloption
|
||||||
|
YYYY-MM-DD Beispiel für Datumsargument
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Beispielausgabe
|
||||||
|
|
||||||
|
```
|
||||||
|
Hier ein Beispieloutput des Skripts.
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Setup-Hinweise
|
||||||
|
|
||||||
|
Falls notwendig, Alias in `~/.bashrc` setzen:
|
||||||
|
```bash
|
||||||
|
alias <scriptname>='~/pfad/zum/repo/<legacy|wh20>/<scriptname>/<scriptname>'
|
||||||
|
```
|
||||||
|
|
||||||
|
Logger-spezifisch ggf. in `~/.profile` ergänzen:
|
||||||
|
```bash
|
||||||
|
cd /var/log/easyname/$(date +%Y)/$(date +%m)/
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Notes
|
||||||
|
|
||||||
|
- Weitere Hinweise, Einschränkungen, Besonderheiten
|
||||||
|
- Ggf. bekannte Bugs oder ToDos
|
||||||
Reference in New Issue
Block a user