Add docs and release steps

diasurgical · Sep 20, 2024 · eed507a · eed507a
1 parent 4704105
commit eed507a
Show file tree

Hide file tree

Showing 2 changed files with 39 additions and 2 deletions.
diff --git a/.github/workflows/dreamcast.yml b/.github/workflows/dreamcast.yml
@@ -6,7 +6,6 @@ on:  # yamllint disable-line rule:truthy
     branches:
       - master
       - dreamcast
-      - dreamcast-sdl
     paths-ignore:
       - '*.md'
       - 'docs/**'
@@ -87,7 +86,7 @@ jobs:
         if: ${{ !env.ACT }}
         uses: actions/upload-artifact@v4
         with:
-          name: devilutionx.zip
+          name: devilutionx
           path: |
             build/data
             build/devilutionx.elf
@@ -98,4 +97,26 @@ jobs:
         with:
           name: devilutionx.cdi
           path: ./build/devilutionx.cdi
+
+      - name: Prepare Releases
+        if: ${{ github.event_name == 'release' && !env.ACT }}
+        run: |
+          apk add zip && \
+            cd build && \
+            zip -r devilutionx-dreamcast.zip data/ devilutionx.elf && \
+            zip -r devilutionx-dreamcast.cdi.zip devilutionx.cdi
+
+      - name: Update Release .cdi
+        if: ${{ github.event_name == 'release' && !env.ACT }}
+        uses: svenstaro/upload-release-action@v2
+        with:
+          file: ./build/devilutionx-dreamcast.cdi.zip
+          overwrite: true
+
+      - name: Update Release .elf
+        if: ${{ github.event_name == 'release' && !env.ACT }}
+        uses: svenstaro/upload-release-action@v2
+        with:
+          file: ./build/devilutionx-dreamcast.zip
+          overwrite: true
 ...
diff --git a/docs/installing.md b/docs/installing.md
@@ -225,3 +225,19 @@ If you'd like to use this option, scan the QR code below.
 - Copy the contents of the released .zip-file onto the root of your SD card
 - Copy the MPQ files to `/Emu/PORTS/Binaries/Diablo.port/FILES_HERE/`
 </details>
+
+<details><summary>Sega Dreamcast</summary>
+
+**Shareware version**
+
+- Download and extract [devilutionx-dreamcast.cdi.zip](https://github.com/diasurgical/devilutionX/releases/latest/download/devilutionx-dreamcast.cdi.zip)
+- Burn it to a CD using a tool like [IMGBURN](https://www.imgburn.com/index.php?act=download) or [dcdib](https://alex-free.github.io/dcdib/)
+
+**Full version** (requires that you provide diabdat.mpq)
+
+- Download [devilutionx-dreamcast.zip](https://github.com/azihassan/devilutionX/releases/download/latest/devilutionx-dreamcast.zip)
+- Extract it and copy diabdat.mpq in the data/ directory
+- Package it into a .cdi file using [mkdcdisc](https://gitlab.com/simulant/mkdcdisc) with the following command: `mkdcdisc -e devilutionx.elf -o devilutionx.cdi --name 'Diablo 1' -d data/`
+- Burn it to a CD using a tool like [IMGBURN](https://www.imgburn.com/index.php?act=download) or [dcdib](https://alex-free.github.io/dcdib/)
+
+</details>