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.

Sign up for GitHub

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

Jump to bottom

Update README tracking issue #14

Closed
10 tasks done
benfrankel opened this issue Jul 4, 2024 · 8 comments · Fixed by #161
Closed
10 tasks done

Update README tracking issue #14

benfrankel opened this issue Jul 4, 2024 · 8 comments · Fixed by #161
Labels
documentation Improvements or additions to documentation
Milestone
Bevy Jam 5

Comments

@benfrankel
Copy link
Collaborator

benfrankel commented Jul 4, 2024 •
edited by janhohenheim
Loading

@benfrankel benfrankel added the documentation Improvements or additions to documentation label Jul 4, 2024
@janhohenheim
Copy link
Member

Copy-pasting some stuff from Discord:

  • no 3rd-party dependencies outside of bevy
  • CI with auto-publish to itch.io
  • some basic game code written out already (states, system sets, menu, credits)
  • extra tooling / conveniences like IDE support, cargo-generate, etc.
  • boilerplate workarounds for common bevy issues like screen flickering etc.

@benfrankel
Copy link
Collaborator Author

Also, #4 is relevant. What is considered "good style" or "idiomatic" will change as new bevy versions are released, so keeping things idiomatic could be a guiding principle as well.

@MiniaczQ MiniaczQ changed the title Put guiding principles for this template in README Update README Jul 5, 2024
@MiniaczQ MiniaczQ mentioned this issue Jul 5, 2024
Closed
@MiniaczQ
Copy link
Collaborator

MiniaczQ commented Jul 6, 2024

#33 (comment)

@benfrankel
Copy link
Collaborator Author

#25

@janhohenheim
Copy link
Member

#53

@benfrankel benfrankel changed the title Update README Update README tracking issue Jul 8, 2024
@benfrankel
Copy link
Collaborator Author

This'll probably be a merge conflict mess, or one person doing all the work, if we do this via PRs. Probably better to work on this as a shared hackmd before making any PRs.

@benfrankel benfrankel mentioned this issue Jul 15, 2024
Merged
@benfrankel benfrankel added this to the Bevy Jam 5 milestone Jul 15, 2024
This was referenced Jul 15, 2024
Merged
Merged
@benfrankel
Copy link
Collaborator Author

Moving to Bevy Jam 6 milestone for the remaining tasks.

@benfrankel benfrankel modified the milestones: Bevy Jam 5, Bevy Jam 6 Jul 17, 2024
benfrankel added a commit that referenced this issue Jul 17, 2024
@benfrankel
Add README-CI-CD.md (#149)
6c2c849 
Related to #14.
benfrankel added a commit that referenced this issue Jul 17, 2024
@benfrankel
Update README.md (#140)
14efedc 
Fixes #120.

Related to #14.

The "CI / CD" and "3rd-party tools" docs will come in later PRs.
benfrankel added a commit that referenced this issue Jul 17, 2024
@benfrankel
Add README-TOOLS.md (#145)
7ff393a 
Fixes #53.

Related to #14.

Will link to this from `README.md` once either PR gets merged.
@janhohenheim janhohenheim mentioned this issue Jul 17, 2024
Merged
@janhohenheim janhohenheim modified the milestones: Bevy Jam 6, Bevy Jam 5 Jul 17, 2024
@janhohenheim
Copy link
Member

janhohenheim commented Jul 17, 2024 •
edited
Loading

Nah I'm getting this done today 💪

@janhohenheim janhohenheim mentioned this issue Jul 18, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
Bevy Jam 5
Development

Successfully merging a pull request may close this issue.

Write design doc TheBevyFlock/bevy_new_2d
3 participants
@janhohenheim @benfrankel @MiniaczQ