Create usage file for the packaged version

DescentDevelopers / Descent3

Descent 3 by Outrage Entertainment

GNU General Public License v3.0

2.88k stars 251 forks source link

Create usage file for the packaged version #521

Closed Lgt2x closed 3 months ago

Lgt2x commented 3 months ago

Pull Request Type

[ ] GitHub Workflow changes
[x] Documentation or Wiki changes
[ ] Build and Dependency changes
[ ] Runtime changes
- [ ] Render changes
- [ ] Audio changes
- [ ] Input changes
- [ ] Network changes
- [ ] Other changes

Description

Ship simplified usage instructions with the pre-compiled binaries.

Related Issues

Part of #506

Lgt2x commented 3 months ago

Before I forget, we need to mention the Wayland trick

Lgt2x commented 3 months ago

I'll need help refining the MacOS usage procedure. Per @tophyr , chmod does not work every time, and you need to run xattr -c /path/to/Descent3.app before being able to run the .app bundle to remove the need for signing. Once this is done, are the assets correctly found in the game directory when you double-click the .app? If not, what command to use to run the app?

Lgt2x commented 3 months ago

README has been split between USAGE and BUILD. I removed special build instructions formatted in HTML because it's an extremely unlikely scenario, and links to a project we do not have control over. We're ready for review! (I'd appreciate a native english speaker to take a look at this and #516, I don't trust my grammar that much)

winterheart commented 3 months ago

LGTM.