Rewrite local README with updated startup instructions #44
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
terraquad
suggested changes
Aug 26, 2024
| ### build.zig | ||
| A depedency step must be added in order for your project to build with mach-glfw. Below | ||
| the line beginning with `const exe = b.addExecutable`, add the following snippet: | ||
| ```typescript |
|
|
||
| ### src/main.zig | ||
| Below follows an example program, to test your functionality: | ||
| ```typescript |
|
|
||
| ## Issues persisting? | ||
| If you're manually configuring your `build.zig.zon`, verify that this structure exists: | ||
| ```typescript |
| - `Monitor.getGammaRamp`, `Monitor.setGammaRamp` | ||
|
|
||
| Non-critical errors (such as the failure of `Window.getPos`) can still be caught and handled: | ||
| ```typescript |
| // ... other dependencies of yours | ||
| .@"mach-glfw" = .{ | ||
| .url = "https://pkg.machengine.org/mach-glfw/FULL_HASH_LATEST_COMMIT.tar.gz", | ||
| .hash = "" // place anything here--zig build will error and give you the correct hash |
There was a problem hiding this comment.
Remove this line, as it being present makes Zig assume the hash should be "". It'll only tell you the correct hash when this line is not present.
dandeduck
reviewed
Sep 22, 2024
|
|
||
| - [hexops/vulkan-zig-generated](https://github.com/hexops/vulkan-zig-generated) | ||
|
|
||
| - OpenGL: [castholm/zigglegen](https://github.com/hexops/mach-glfw-opengl-example) - [example](https://github.com/hexops/mach-glfw-opengl-example) |
There was a problem hiding this comment.
Should be https://github.com/castholm/zigglgen
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This document maintains most of the original language in the previous README, while incorporating a modernized version of the information found here. This project and its test provided here executes as-intended with zig version
0.13.0-dev.351+64ef45eb0on macos-aarch64.