diff --git a/.DS_Store b/.DS_Store new file mode 100644 index 00000000..be41f95d Binary files /dev/null and b/.DS_Store differ diff --git a/.github/workflows/esp32p4-build-master.yml b/.github/workflows/esp32p4-build-master.yml index cbc645cb..8f3661c4 100644 --- a/.github/workflows/esp32p4-build-master.yml +++ b/.github/workflows/esp32p4-build-master.yml @@ -178,7 +178,7 @@ jobs: files+=("firmware/M5MonsterC5-Tab5-${FW_VERSION}.zip") fi - out="bundle/M5MonsterC5-Tab5-${FW_VERSION}.zip" + out="bundle/M5MonsterC5-Tab5-${FW_VERSION}-bundle.zip" zip -9 "$out" "${files[@]}" - name: Build release notes @@ -193,7 +193,7 @@ jobs: TAG="${RELEASE_TAG:-$FW_VERSION}" BASE_URL="https://github.com/$REPO/releases/download/$TAG" FW_ZIP="$BASE_URL/M5MonsterC5-Tab5-${FW_VERSION}.zip" - BUNDLE_ZIP="$BASE_URL/M5MonsterC5-Tab5-${FW_VERSION}.zip" + BUNDLE_ZIP="$BASE_URL/M5MonsterC5-Tab5-${FW_VERSION}-bundle.zip" RELEASE_PAGE="https://github.com/$REPO/releases/tag/$TAG" PAGES_LINK="https://${REPO%/*}.github.io/${REPO#*/}/" @@ -207,7 +207,7 @@ jobs: if [ "${GITHUB_EVENT_NAME:-}" = "release" ]; then if [ -n "${GITHUB_EVENT_PATH:-}" ] && [ -f "${GITHUB_EVENT_PATH:-}" ]; then - release_body="$(jq -r '.release.body // \"\"' "$GITHUB_EVENT_PATH")" + release_body="$(jq -r '.release.body // ""' "$GITHUB_EVENT_PATH")" if [ -n "$(printf '%s' "$release_body" | tr -d '\r\n[:space:]')" ]; then printf '%s\n' "$release_body" >> "$notes_file" fi @@ -218,8 +218,8 @@ jobs: if command -v gh >/dev/null 2>&1; then api="/repos/${GITHUB_REPOSITORY}/commits/${GITHUB_SHA}/pulls" pr_json="$(gh api -H \"Accept: application/vnd.github+json\" \"$api\" 2>/dev/null || echo '[]')" - pr_title="$(printf '%s' "$pr_json" | jq -r '.[0].title // \"\"')" - pr_body="$(printf '%s' "$pr_json" | jq -r '.[0].body // \"\"')" + pr_title="$(printf '%s' "$pr_json" | jq -r '.[0].title // ""')" + pr_body="$(printf '%s' "$pr_json" | jq -r '.[0].body // ""')" if [ -n "$(printf '%s' "$pr_body" | tr -d '\r\n[:space:]')" ]; then if [ -n "$pr_title" ]; then @@ -232,7 +232,7 @@ jobs: gen_json="$(gh api -X POST -H \"Accept: application/vnd.github+json\" \ "/repos/${GITHUB_REPOSITORY}/releases/generate-notes" \ -f tag_name="$TAG" -f target_commitish="$GITHUB_SHA" 2>/dev/null || echo '')" - gen_body="$(printf '%s' "$gen_json" | jq -r '.body // \"\"')" + gen_body="$(printf '%s' "$gen_json" | jq -r '.body // ""')" if [ -n "$(printf '%s' "$gen_body" | tr -d '\r\n[:space:]')" ]; then printf '%s\n' "$gen_body" >> "$notes_file" fi @@ -253,7 +253,7 @@ jobs: release_artifacts/firmware/M5MonsterC5-Tab5.bin release_artifacts/firmware/M5MonsterC5-Tab5-${{ needs.firmware.outputs.fw_version }}.bin release_artifacts/firmware/M5MonsterC5-Tab5-${{ needs.firmware.outputs.fw_version }}.zip - release_artifacts/bundle/M5MonsterC5-Tab5-${{ needs.firmware.outputs.fw_version }}.zip + release_artifacts/bundle/M5MonsterC5-Tab5-${{ needs.firmware.outputs.fw_version }}-bundle.zip env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} diff --git a/README.md b/README.md index 9ec216c0..6163da88 100644 --- a/README.md +++ b/README.md @@ -1 +1,31 @@ # M5MonsterC5-Tab5 + + +--- + +## Info / Flash + +The project is based on the ESP32C5-Wroom-1U and consists of two software components: + +- JanOS on the MonsterC5 board - flasher: https://c5lab.github.io/projectZero/janos_flash.html +- App for the M5Stack Tab5 - flasher: https://c5lab.github.io/M5MonsterC5-Tab5/janos_flash.html + +M5MonsterC5-Tab5 is an add-on board built around the M5MonsterC5 platform and based on JanOS from the Project Zero repository. +It is intended for M5Stack Tab5 devices, and it can also be used with Android and PC/MacOS over a USB connection. + +Project Zero (JanOS): https://github.com/C5Lab/projectZero + +--- + +## Documentation + +Full documentation and usage details are available on the wiki: +https://github.com/C5Lab/M5MonsterC5-Tab5/wiki + +## Availability + +[The board available on Tindie.](https://www.tindie.com/products/lab/m5monsterc5-esp32c5-marauder/) + +## Community + +Discord: https://discord.gg/57wmJzzR8C diff --git a/docs/.DS_Store b/docs/.DS_Store new file mode 100644 index 00000000..c27303a4 Binary files /dev/null and b/docs/.DS_Store differ diff --git a/docs/tab.stories/.DS_Store b/docs/tab.stories/.DS_Store new file mode 100644 index 00000000..0e9084f4 Binary files /dev/null and b/docs/tab.stories/.DS_Store differ diff --git a/docs/tab.stories/index.html b/docs/tab.stories/index.html new file mode 100644 index 00000000..56ed6202 --- /dev/null +++ b/docs/tab.stories/index.html @@ -0,0 +1,511 @@ + + +
+ + +
+
+ Tutorial
++ Open a module to view its image walkthrough. +
+ +
+ + modular Wi-Fi offensive and research toolkit for M5Stack Tab5. + Acts as a wrapper for ESP32C5 with JanOS software. +
+
+ + Full compatibility with M5 modules and zero soldering required. +Designed for plug-and-play use +
+
+ Tutorial
+Bluetooth discovery and locate.
+
+ Tutorial
+Global attack modes overview.
+
+ Tutorial
+Karma flow on Monsters C5.
+
+ Tutorial
+Network Observer with internal C6 Karma.
+
+ Tutorial
+WiFi scan and attack workflow.
+
+ Tutorial
+Settings and stored captures.
+