Skip to content

Commit

Permalink
add readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
jmctune committed Mar 21, 2024
1 parent f723574 commit ac2d82f
Showing 1 changed file with 28 additions and 0 deletions.
28 changes: 28 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# dqx_en_launcher

Modifies the DQX launcher with a number of English assets to make for a more readable experience to an English audience.

# ci

This builds on pushes to main and tags.

On pushes to main, check the GHA logs for the "Build launcher exe" step and make sure the log output looks OK. For tags, this will build and create a new release, attaching the modified executable to the release.

# updating

- Open a PR and replace `DQXLauncher.exe` in the `assets` folder with the latest launcher
- Merge PR and verify that the executable built (check the previous GHA logs)
- Cut a new tag, which will publish a new release

# development

You can build this locally, but the asset swaps for the two ETPs folders in `assets/ETP` are only done in CI. This only builds locally with the ETPs that were already in the executable.

To run:

```powershell
cd app
port_assets.bat
```

This will spit out a `DQXLauncher.log` file, and if successful, a `DQXLauncher.exe` in the `app` directory.

0 comments on commit ac2d82f

Please sign in to comment.