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

Add documentation for web commands to README #223

Merged
merged 3 commits into from
Jan 13, 2025
Merged

Conversation

TimJentzsch
Copy link
Collaborator

Objective

Closes #204.

It's currently hard for users to discover how to use the web-specific functionality of the CLI.
As a first step, we should expand the README to give an overview of the provided features.

Solution

  • Add installation instructions
  • Add an overview of the main features and configuration options

README.md Outdated Show resolved Hide resolved
Copy link

@ChristopherBiscardi ChristopherBiscardi left a comment

Choose a reason for hiding this comment

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

lgtm

@TimJentzsch TimJentzsch requested a review from BD103 January 12, 2025 21:14
@TimJentzsch TimJentzsch added C-Docs An improvement in documentation A-Run Related to the bevy run command A-Build Related to the bevy build command A-Web Building or running Bevy apps targeting the browser labels Jan 12, 2025
Copy link
Member

@BD103 BD103 left a comment

Choose a reason for hiding this comment

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

Generally looks good, just one comment!

README.md Outdated Show resolved Hide resolved
@TimJentzsch TimJentzsch added the D-Trivial Nice and easy! A great choice to get started with Bevy CLI label Jan 13, 2025
@TimJentzsch TimJentzsch enabled auto-merge (squash) January 13, 2025 16:07
@TimJentzsch TimJentzsch merged commit 6702a64 into main Jan 13, 2025
8 checks passed
@TimJentzsch TimJentzsch deleted the 204-web-docs branch January 13, 2025 16:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-Build Related to the bevy build command A-Run Related to the bevy run command A-Web Building or running Bevy apps targeting the browser C-Docs An improvement in documentation D-Trivial Nice and easy! A great choice to get started with Bevy CLI
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add user-facing documentation for web functionality
3 participants