xrsh
/
packages
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

main: update documentation

This commit is contained in:
Leon van Kammen 2025-03-27 11:39:08 +01:00
parent dbdb34d8c5
commit 97ebae99e7
2 changed files with 11 additions and 3 deletions

6
README.md
View File

@ -9,3 +9,9 @@
# Packages
| package | description |
|-|-|
| [fzy](fzy) | lightweight + fast fuzzyfinder alternative |
| [vim](vim) | Most popular clone of the VI editor |
> developers: run `echo "$(./README.sh)" > README.md` to regenerate this README.md after adding a pkg

8
README.sh
View File

@ -1,9 +1,11 @@
# printf README.md until '# Component List'
#!/bin/sh
# print 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) |"
echo "| [$pkg]($pkg) | $(awk 'NR == 3 {print $0}' $pkg/README.md) |"
done
echo -e "\n> developers: run `./README.sh` to regenerate this README.md after adding a pkg"
echo -e '\n> developers: run `echo "$(./README.sh)" > README.md` to regenerate this README.md after adding a pkg'