diff --git a/README.md b/README.md index 36a1410..df70dba 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,8 @@ # firmware-open + System76 Open Source Firmware + +- [Applications](./apps/README.md) +- [Libraries](./libs/README.md) +- [Models](./models/README.md) +- [Tools](./tools/README.md) diff --git a/apps/README.md b/apps/README.md new file mode 100644 index 0000000..78129ea --- /dev/null +++ b/apps/README.md @@ -0,0 +1,3 @@ +# Applications +- [System76 Firmware Setup](https://github.com/system76/firmware-setup.git) +- [System76 Firmware Update](https://github.com/system76/firmware-update.git) diff --git a/apps/firmware-update b/apps/firmware-update index ffa64d7..8c11731 160000 --- a/apps/firmware-update +++ b/apps/firmware-update @@ -1 +1 @@ -Subproject commit ffa64d73b123592773ae4703de7c4d8abf77454a +Subproject commit 8c11731e2b13bb4c13e60362be2cda3fada61dca diff --git a/libs/README.md b/libs/README.md new file mode 100644 index 0000000..c604091 --- /dev/null +++ b/libs/README.md @@ -0,0 +1,6 @@ +# Libraries +- [coreboot-table](https://gitlab.redox-os.org/redox-os/coreboot-table.git) +- [ecflash](https://github.com/system76/ecflash.git) +- [intelflash](https://gitlab.redox-os.org/redox-os/intelflash.git) +- [intel-spi](https://github.com/system76/intel-spi.git) +- [uefi_std](https://gitlab.redox-os.org/redox-os/uefi_std.git) diff --git a/models/README.md.sh b/models/README.md.sh deleted file mode 100755 index 38c4b63..0000000 --- a/models/README.md.sh +++ /dev/null @@ -1,6 +0,0 @@ -echo "# Models" > README.md -for readme in ./*/README.md -do - line="$(head -n 1 "$readme" | cut -d ' ' -f2-)" - echo "- [$line]($readme)" >> README.md -done diff --git a/readme.sh b/readme.sh new file mode 100755 index 0000000..eecc7a3 --- /dev/null +++ b/readme.sh @@ -0,0 +1,35 @@ +#!/usr/bin/env bash + +READMES=( + "apps Applications" + "libs Libraries" + "models Models" + "tools Tools" +) + +function recursive_readme { + pushd "$1" > /dev/null + echo -e "\x1B[1m$1\x1B[0m" + echo "# $2" > README.md + for readme in */README.md + do + # Get first line, removing the trailing pounds and spaces + description="$(head -n 1 "$readme" | sed -e 's/^[#[:space:]]*//')" + # Get submodule, if applicable + dir="$(dirname "$readme")" + submodule="$(git submodule status "$dir" | cut -d ' ' -f 3)" + if [ "$submodule" == "$dir" ] + then + origin="$(git -C "$dir" remote get-url origin)" + echo "- [$description]($origin)" >> README.md + else + echo "- [$description](./$readme)" >> README.md + fi + done + popd > /dev/null +} + +for readme in "${READMES[@]}" +do + recursive_readme $readme +done diff --git a/tools/README.md b/tools/README.md new file mode 100644 index 0000000..d1ddee0 --- /dev/null +++ b/tools/README.md @@ -0,0 +1,6 @@ +# Tools +- [coreboot-collector](https://github.com/system76/coreboot-collector.git) +- [ME Analyzer](https://github.com/platomav/MEAnalyzer.git) +- [UEFITool](https://github.com/LongSoft/UEFITool.git) +- [Intel ME 11.x Firmware Images Unpacker](https://github.com/ptresearch/unME11.git) +- [Intel ME 12.x Firmware Images Unpacker](https://github.com/ptresearch/unME12.git)