Replace README "Getting Started" section - #145
Merged
Merged
Conversation
Collaborator
Author
|
Notably, I kept all the paragraphs on the same line, as potential future in-line changes will be easier to track, without having to re-layout other lines to fit the text. If requested, I could either format the text as the rest of the existing readme, or change the rest of the readme to get rid of the linebreaks. |
PGComai
reviewed
Sep 23, 2025
Co-authored-by: Alex Comai <comai.alex@gmail.com>
Collaborator
Author
|
Updated the required Godot version to 4.6.x (since currently 4.7 doesn't work?), so this should be good to merge? Remember to update the version requirement stated in the readme when updating to 4.7 stuff. |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
I figured this might improve the readme by pointing people to the releases, and cleaning up the instructions for running the project from the editor. There's a lot of options and modules to tweak things now so I left it to the basics – I even left out a suggestion on using the blendshape conversion for simplicity. Proper documentation should either be in SnekStudio itself or a dedicated page. For now it might be good enough to just forward people to the community channels.
Feedback welcome.