Skip to content

Commit 2461ab9

Browse files
kelpsyberrykelpsyberry
committed
Update README, rename workflows
1 parent b6d1d18 commit 2461ab9

File tree

5 files changed

+33
-30
lines changed

5 files changed

+33
-30
lines changed

‎.github/workflows/build-release-macos-app-bundles.yml

+3-3
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ jobs:
7676
-create
7777
-output Dust.app/Contents/MacOS/Dust
7878
79-
tar -czf Dust.app.tar.gz Dust.app
79+
tar -cf Dust.app.tar.gz Dust.app
8080
8181
- name: Upload release bundle (no debugging features)
8282
uses: actions/upload-artifact@v4
@@ -108,7 +108,7 @@ jobs:
108108
-create
109109
-output Dust.app/Contents/MacOS/Dust
110110
111-
tar -czf Dust.app.tar.gz Dust.app
111+
tar -cf Dust.app.tar.gz Dust.app
112112
113113
- name: Upload release bundle (debugging features)
114114
uses: actions/upload-artifact@v4
@@ -142,7 +142,7 @@ jobs:
142142
143143
cp -R frontend/desktop/src/emu/gdb_server/specs Dust.app/Contents/Resources
144144
145-
tar -czf Dust.app.tar.gz Dust.app
145+
tar -cf Dust.app.tar.gz Dust.app
146146
147147
- name: Upload release bundle (debugging features + GDB)
148148
uses: actions/upload-artifact@v4

‎.github/workflows/build-release.yml

+3-3
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ jobs:
7777
7878
tar
7979
-C target/${{ matrix.target }}/ci
80-
-czf dust-desktop.tar.gz
80+
-cf dust-desktop.tar.gz
8181
dust-desktop${{ matrix.artifact-extension }}
8282
8383
- name: Upload release binary (no debugging features)
@@ -98,7 +98,7 @@ jobs:
9898
9999
tar
100100
-C target/${{ matrix.target }}/ci
101-
-czf dust-desktop.tar.gz
101+
-cf dust-desktop.tar.gz
102102
dust-desktop${{ matrix.artifact-extension }}
103103
104104
- name: Upload release binary (debugging features)
@@ -119,7 +119,7 @@ jobs:
119119
120120
tar
121121
-C target/${{ matrix.target }}/ci
122-
-czf dust-desktop.tar.gz
122+
-cf dust-desktop.tar.gz
123123
dust-desktop${{ matrix.artifact-extension }}
124124
125125
- name: Upload release binary (debugging features + GDB)

‎.github/workflows/run-clippy-and-test.yml renamed to ‎.github/workflows/clippy.yml

+3-9
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: Run Clippy and test
1+
name: Clippy
22

33
on:
44
push:
@@ -11,8 +11,8 @@ env:
1111
MACOSX_DEPLOYMENT_TARGET: 10.11
1212

1313
jobs:
14-
run-clippy-and-test:
15-
name: Run Clippy and test (${{ matrix.os }})
14+
clippy:
15+
name: Clippy (${{ matrix.os }})
1616
strategy:
1717
matrix:
1818
os: [windows-latest, ubuntu-latest, macos-latest]
@@ -56,9 +56,3 @@ jobs:
5656
name: Run clippy (${{ matrix.os }}, all features)
5757
token: ${{ secrets.GITHUB_TOKEN }}
5858
args: --no-default-features --features=${{ env.FEATURES }} --package dust-desktop
59-
60-
- name: Run tests (no default features)
61-
run: cargo test --verbose --no-default-features --package dust-desktop
62-
63-
- name: Run tests (all features)
64-
run: cargo test --verbose --features=${{ env.FEATURES }} --package dust-desktop

‎README.md

+23-13
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,43 @@
11
# Dust
22

3-
![Screenshot](screenshot.png)
3+
[![Build status](https://github.com/kelpsyberry/dust/actions/workflows/clippy.yml/badge.svg?branch=main&event=push)](https://github.com/kelpsyberry/dust/actions/workflows/clippy.yml?query=branch%3Amain+event%3Apush)
4+
[![Discord server](https://dcbadge.vercel.app/api/server/MRDEvx8rKy?style=flat&theme=default-inverted)](https://discord.gg/MRDEvx8rKy)
45

5-
[![Build and test status](https://github.com/kelpsyberry/dust/actions/workflows/.github/workflows/run-clippy-and-test.yml/badge.svg?branch=main&event=push)](https://github.com/kelpsyberry/dust/actions/workflows/run-clippy-and-test.yml?query=branch%3Amain+event%3Apush)
6+
![Screenshot](screenshot.png)
67

7-
## Prebuilt binaries and web version
8+
## Web version
89

9-
[![Web deploy status](https://github.com/kelpsyberry/dust/actions/workflows/.github/workflows/deploy-web.yml/badge.svg?branch=main&event=push)](https://github.com/kelpsyberry/dust/actions/workflows/deploy-web.yml?query=branch%3Amain+event%3Apush)
10+
[![Web deploy status](https://github.com/kelpsyberry/dust/actions/workflows/deploy-web.yml/badge.svg?branch=main&event=push)](https://github.com/kelpsyberry/dust/actions/workflows/deploy-web.yml?query=branch%3Amain+event%3Apush)
1011

1112
[Web frontend](https://dust-emu.netlify.app)
1213

14+
## Prebuilt binaries
15+
16+
[![Binary release build status](https://github.com/kelpsyberry/dust/actions/workflows/build-release.yml/badge.svg?branch=main&event=push)](https://github.com/kelpsyberry/dust/actions/workflows/build-release.yml?query=branch%3Amain+event%3Apush)
17+
[![macOS app bundle release build status](https://github.com/kelpsyberry/dust/actions/workflows/build-release-macos-app-bundles.yml/badge.svg?branch=main&event=push)](https://github.com/kelpsyberry/dust/actions/workflows/build-release-macos-app-bundles.yml?query=branch%3Amain+event%3Apush)
18+
19+
- The base configuration only includes all features necessary to run games as an end user
20+
- The debugging configuration additionally enables logging of diagnostic events on the emulated system (i.e. invalid I/O device usage or port accesses) and several debugging views (i.e. memory and register viewer and a disassembly view), all accessible from the Debug menu
21+
- The debugging + GDB server configuration also enables support for a GDB client to attach to and debug the emulated program, by starting/stopping the server from the Debug menu while running a program
1322

14-
[![Release build status](https://github.com/kelpsyberry/dust/actions/workflows/.github/workflows/build-release.yml/badge.svg?branch=main&event=push)](https://github.com/kelpsyberry/dust/actions/workflows/build-release.yml?query=branch%3Amain+event%3Apush)
23+
> **NB**: The debugging configurations only add debugging features for loaded programs; all binaries are compiled with optimizations and don't include debug symbols for the emulator itself.
1524
16-
| Release | Debug (includes logging and debugging views) | Debug + GDB server |
17-
| ------- | -------------------------------------------- | ------------------ |
18-
| [Windows (release)](https://nightly.link/kelpsyberry/dust/workflows/build-release/main/Windows.zip) | [Windows (debug)](https://nightly.link/kelpsyberry/dust/workflows/build-release/main/Windows-debug.zip) | [Windows (debug + GDB)](https://nightly.link/kelpsyberry/dust/workflows/build-release/main/Windows-debug-gdb.zip) |
19-
| [Linux (release)](https://nightly.link/kelpsyberry/dust/workflows/build-release/main/Linux.zip) | [Linux (debug)](https://nightly.link/kelpsyberry/dust/workflows/build-release/main/Linux-debug.zip) | [Linux (debug + GDB)](https://nightly.link/kelpsyberry/dust/workflows/build-release/main/Linux-debug-gdb.zip) |
20-
| [macOS x86_64 (release)](https://nightly.link/kelpsyberry/dust/workflows/build-release/main/macOS-x86_64.zip) | [macOS x86_64 (debug)](https://nightly.link/kelpsyberry/dust/workflows/build-release/main/macOS-x86_64-debug.zip) | [macOS x86_64 (debug + GDB)](https://nightly.link/kelpsyberry/dust/workflows/build-release/main/macOS-x86_64-debug-gdb.zip) |
21-
| [macOS ARM64 (release)](https://nightly.link/kelpsyberry/dust/workflows/build-release/main/macOS-aarch64.zip) | [macOS ARM64 (debug)](https://nightly.link/kelpsyberry/dust/workflows/build-release/main/macOS-aarch64-debug.zip) | [macOS ARM64 (debug + GDB)](https://nightly.link/kelpsyberry/dust/workflows/build-release/main/macOS-aarch64-debug-gdb.zip) |
25+
| OS and binary type | Base | Debugging | Debugging + GDB server |
26+
| ------------------ | ---- | --------- | ---------------------- |
27+
| Windows x86_64 .exe | [Windows.zip](https://nightly.link/kelpsyberry/dust/workflows/build-release/main/Windows.zip) | [Windows-debug.zip](https://nightly.link/kelpsyberry/dust/workflows/build-release/main/Windows-debug.zip) | [Windows-debug-gdb.zip](https://nightly.link/kelpsyberry/dust/workflows/build-release/main/Windows-debug-gdb.zip) |
28+
| Linux x86_64 binary | [Linux.zip](https://nightly.link/kelpsyberry/dust/workflows/build-release/main/Linux.zip) | [Linux-debug.zip](https://nightly.link/kelpsyberry/dust/workflows/build-release/main/Linux-debug.zip) | [Linux-debug-gdb.zip](https://nightly.link/kelpsyberry/dust/workflows/build-release/main/Linux-debug-gdb.zip) |
29+
| macOS universal app | [macOS-app.zip](https://nightly.link/kelpsyberry/dust/workflows/build-release-macos-app-bundles/main/macOS-app.zip) | [macOS-app-debug.zip](https://nightly.link/kelpsyberry/dust/workflows/build-release-macos-app-bundles/main/macOS-app-debug.zip) | [macOS-app-debug-gdb.zip](https://nightly.link/kelpsyberry/dust/workflows/build-release-macos-app-bundles/main/macOS-app-debug-gdb.zip) |
30+
| macOS x86_64 binary | [macOS-x86_64.zip](https://nightly.link/kelpsyberry/dust/workflows/build-release/main/macOS-x86_64.zip) | [macOS-x86_64-debug.zip](https://nightly.link/kelpsyberry/dust/workflows/build-release/main/macOS-x86_64-debug.zip) | [macOS-x86_64-debug-gdb.zip](https://nightly.link/kelpsyberry/dust/workflows/build-release/main/macOS-x86_64-debug-gdb.zip) |
31+
| macOS ARM64 binary | [macOS-aarch64.zip](https://nightly.link/kelpsyberry/dust/workflows/build-release/main/macOS-aarch64.zip) | [macOS-aarch64-debug.zip](https://nightly.link/kelpsyberry/dust/workflows/build-release/main/macOS-aarch64-debug.zip) | [macOS-aarch64-debug-gdb.zip](https://nightly.link/kelpsyberry/dust/workflows/build-release/main/macOS-aarch64-debug-gdb.zip) |
2232

23-
# Credits
33+
## Credits
2434
- Martin Korth, for summarizing resources on the DS on [GBATEK](https://problemkaputt.de/gbatek.htm)
2535
- [Arisotura](https://github.com/Arisotura), for her research on the system in melonDS, [test ROMs](https://github.com/Arisotura/arm7wrestler) and [corrections and additions to the info on GBATEK](https://melonds.kuribo64.net/board/thread.php?id=13), and for the game database used in this emulator
2636
- [StrikerX3](https://github.com/StrikerX3), for his research on 3D rendering on the DS
2737
- [Simone Coco](https://github.com/CocoSimone), [Fleroviux](https://github.com/fleroviux), [Lady Starbreeze](https://github.com/LadyStarbreeze), [Merry](https://github.com/merryhime), [Powerlated](https://github.com/Powerlated) and [Peach](https://github.com/wheremyfoodat) for help throughout development
2838
- The Emulation Development server on Discord as a whole, for providing several invaluable resources
2939

30-
# Sister projects
40+
## Sister projects
3141
- [**Kaizen**](https://github.com/SimoneN64/Kaizen): Experimental work-in-progress low-level N64 emulator
3242
- [**n64**](https://github.com/Dillonb/n64): Low-level, accurate, fast and easy to use Nintendo 64 emulator
3343
- [**Panda3DS**](https://github.com/wheremyfoodat/Panda3DS): A new HLE Nintendo 3DS emulator

‎core/src/audio/channel.rs

+1-2
Original file line numberDiff line numberDiff line change
@@ -337,9 +337,8 @@ impl Channel {
337337
self.check_total_size();
338338
}
339339

340-
// TODO: Makes Clippy crash right now?
341-
// #[allow(clippy::unused_self)]
342340
#[inline]
341+
#[allow(clippy::unused_self)]
343342
fn keep_last_sample(&mut self) {
344343
#[cfg(feature = "xq-audio")]
345344
self.hist.copy_within(1.., 0);

0 commit comments

Comments
 (0)