Skip to content

Commit

Permalink
feat: improve root README.md with features and other links
Browse files Browse the repository at this point in the history
  • Loading branch information
BD103 committed Oct 20, 2024
1 parent 2373f67 commit fc10f2f
Showing 1 changed file with 6 additions and 7 deletions.
13 changes: 6 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,13 @@
# Bevy CLI

A Bevy CLI tool.
A prototype [Bevy](https://bevyengine.org) CLI tool intended to streamline common tasks when working on projects. Please see the [initial scope document](https://hackmd.io/cCHAfbtaSviU_MDnbNHKxg) and [original issue](https://github.com/bevyengine/bevy/issues/436) for history and motivation. The CLI's current features include:

Please note that this project is still a prototype. It may eventually be upstreamed into the main [Bevy Engine organization], but for now is an unofficial community project.
- Project generation from a template
- [A custom, Bevy-specific linter](bevy_lint/README.md)
- Out-of-the-box support for bundling projects into WebAssembly
- An HTTP server for testing these WASM bundles

[Bevy Engine organization]: https://github.com/bevyengine

## Bevy Linter

For more information specific to `bevy_lint`, please see [its `README.md`](bevy_lint/README.md).
If you need assistance or want to help, reach out the [`bevy_cli` working group channel](https://discord.com/channels/691052431525675048/1278871953721262090) in the [Bevy Discord](https://discord.gg/bevy).

## License

Expand Down

0 comments on commit fc10f2f

Please sign in to comment.