Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Docs, Add Docker Releases & ARM64 Support #843

Open
wants to merge 9 commits into
base: master
Choose a base branch
from

Conversation

dexxiez
Copy link
Contributor

@dexxiez dexxiez commented Jul 14, 2024

Alrighty so

  • Updated the repo README.md, split development instructions into a DEVELOPMENT.md to make the front page look less scary for "normies". Added docker instructions for those who wish.
  • Add docker builds in release workflow
  • added wowsimcli binaries to .gitignore
  • adjusted makefile to build and compress binaries for both amd64 and arm64 architectures. Docker image will be published in both amd64 and arm64 variants to support those who prefer cheaper hardware or want to run it on a NAS etc.
  • Also reformatted that section of the makefile to make it readable without crosseyedness.

Closes #801

@1337LutZ
Copy link
Contributor

Very nice, thanks for this 👏

@1337LutZ 1337LutZ requested a review from kayla-glick July 14, 2024 15:39
@rosenrusinov
Copy link
Contributor

I want to merge this but without having access to my machine I wont be able to revert if I find something wrong. @1337LutZ @kayla-glick if you can find some time for this it would be lovely to merge.

@dexxiez
Copy link
Contributor Author

dexxiez commented Jul 25, 2024

Synced branch, still looks fine.

@dexxiez
Copy link
Contributor Author

dexxiez commented Aug 4, 2024

Merge conflict resolved due to test placement in main.

@dexxiez
Copy link
Contributor Author

dexxiez commented Aug 12, 2024

@kayla-glick just a friendly reminder to review this one xx


- Docker is available in OS X as well, so in theory similar instructions should work for the Docker method
- You can also use the Ubuntu setup instructions as above to run natively, with a few modifications:
- You may need a different Go installer if `go1.18.3.linux-amd64.tar.gz` is not compatible with your system's architecture; you can do the Go install manually from `https://go.dev/doc/install`.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like this still references an older Go version

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would probably recommend that people download Go directly from the official Go website just to make sure that people get the right version for their architecture (thanks Apple)

# This allows for more rapid development, with sub second reloads on TS changes. This combines the benefits of `WATCH=1 make rundevserver` and `WATCH=1 make host`
# to create something that allows you to work in any part of the code with ease and speed.
# This might get rolled into `WATCH=1 make rundevserver` at some point.
WATCH=1 make devmode
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we call out that this is the recommended way to run the server?

make items
```

# Adding a Sim
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These instructions are all out-of-date at this point but since they were already that way no need to fix them in this PR

Copy link
Contributor

@kayla-glick kayla-glick left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just some minor things then ✅ . Sorry it took so long! I haven't been keeping up with Cata. Please feel free to ping me in the Discord if you need reviews!

@dexxiez
Copy link
Contributor Author

dexxiez commented Aug 21, 2024

Just some minor things then ✅ . Sorry it took so long! I haven't been keeping up with Cata. Please feel free to ping me in the Discord if you need reviews!

No problems, thanks. I'll find some time over the next few days 😺

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Publishing docker image
4 participants