docs: update README, create submodules

Author: zmeyers-ampere

.github/workflows/update-submodules.yml

@@ -0,0 +1,40 @@
+name: Update Submodules
+
+on:
+  workflow_dispatch:
+  schedule:
+    - cron: '0 6 * * 1' # run every Monday at 6AM UTC
+  push:
+
+jobs:
+  update-submodules:
+    runs-on: self-hosted
+
+    steps:
+      - name: Checkout repository (with submodules)
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          submodules: recursive
+
+      - name: Update submodules
+        run: |
+          git submodule update --remote --merge --recursive
+
+      - name: Check for submodule changes
+        run: |
+          if ! git diff --quiet; then
+            echo "Submodule changes detected."
+            echo "changes=true" >> $GITHUB_ENV
+          else
+            echo "No submodule changes detected."
+          fi
+
+      - name: Commit and push updates
+        if: env.changes == 'true'
+        run: |
+          git config user.name "github-actions[bot]"
+          git config user.email "github-actions[bot]@users.noreply.github.com"
+          git add projects/*
+          git commit -m "chore(submodules): update [skip ci]"
+          git push origin HEAD:main

.gitmodules

@@ -0,0 +1,12 @@
+[submodule "projects/AmperePerformanceToolkit"]
+	path = projects/AmperePerformanceToolkit
+	url = https://github.com/AmpereComputing/AmperePerformanceToolkit.git
+	branch = main
+[submodule "projects/ampere-pmu-profiler"]
+	path = projects/ampere-pmu-profiler
+	url = https://github.com/AmpereComputing/ampere-pmu-profiler.git
+	branch = main
+[submodule "projects/ampere-porting-advisor"]
+	path = projects/ampere-porting-advisor
+	url = https://github.com/AmpereComputing/ampere-porting-advisor.git
+	branch = main

LICENSE

@@ -0,0 +1,28 @@
+BSD 3-Clause License
+
+Copyright (c) 2025 Ampere Computing LLC
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

README.md

@@ -1,2 +1,19 @@
-# ampere-performance-toolkit
-Umbrella project that unifies Ampere-built tools for performance benchmarking, hardware/software profiling, and porting.
+![Ampere Logo](https://ampereaimodelzoo.s3.eu-central-1.amazonaws.com/ampere_logo_®_primary_stacked_rgb.png "Ampere Logo")
+# Ampere Performance Toolkit
+
+[![Update Submodules](https://github.com/AmpereComputing/ampere-performance-toolkit/actions/workflows/update-submodules.yml/badge.svg)](https://github.com/AmpereComputing/ampere-performance-toolkit/actions/workflows/update-submodules.yml) [![License](https://img.shields.io/badge/License-BSD--3-blue)](https://github.com/AmpereComputing/ampere-performance-toolkit/blob/main/LICENSE)
+
+Umbrella project with Ampere-built tools for performance benchmarking, hardware/software profiling, and porting.
+
+To clone all submodules under `projects/`
+
+```bash
+git clone --recurse-submodules https://github.com/AmpereComputing/ampere-performance-toolkit.git
+```
+
+A workflow in GitHub CI (self-hosted runner) updates submodules every Monday at 6AM UTC.
+
+## Contributions
+
+Contributions are welcome, please submit them to the relevant submodule's main repository (conforming to each project's CONTRIBUTING guide).
+