main: update documentation

This commit is contained in:
Leon van Kammen 2025-03-27 11:03:56 +01:00
parent a78bca8900
commit dbdb34d8c5
2 changed files with 20 additions and 0 deletions

11
README.md Normal file
View file

@ -0,0 +1,11 @@
<img src='https://xrsh.isvery.ninja/xrsh.svg' width="25%"/>
[XRSH](https://xrsh.isvery.ninja) supports (zip) packages:
* to act as filesystem overlay
* to act as application container (via autoenv's `.env`-file)
> Read more [about XRSH packages](https://xrsh.isvery.ninja/#XRSH%20zip%20packages)
# Packages

9
README.sh Executable file
View file

@ -0,0 +1,9 @@
# printf README.md until '# Component List'
grep -B9999 '# Packages' README.md
echo ''
echo '| package | description |'
echo '|-|-|'
find * -maxdepth 0 -type d | while read pkg; do
echo "| [$pkg]($pkg) | $(awk 'NR == 3' $pkg/README.md) |"
done
echo -e "\n> developers: run `./README.sh` to regenerate this README.md after adding a pkg"