Open
Conversation
trezy
requested changes
Apr 9, 2025
Collaborator
trezy
left a comment
There was a problem hiding this comment.
I appreciate the effort! We really need to remove most of the content from the README since it's all available on the website now. This is a solid start!
Comment on lines
+38
to
+63
| **If you want to start a new React project from scratch, we recommend one of the following options:** | ||
|
|
||
| 1. **Use the official [CLI tool to create PixiJS](https://pixijs.io/create-pixi/) projects, and choose the React | ||
| template:** | ||
|
|
||
| Select the React template from Framework Templates: | ||
|
|
||
| ```bash | ||
| ? Select a type of template: › - Use arrow-keys. Return to submit. | ||
| Bundler Templates | ||
| ❯ Framework Templates | ||
| Creation Templates | ||
| Extension | ||
|
|
||
| ✔ Select a type of template: › Framework Templates | ||
| ? Select a variant: › - Use arrow-keys. Return to submit. | ||
| ❯ React | ||
| ``` | ||
|
|
||
| **This will create a new React + Vite project, with Pixi.js and `@pixi/react` already preconfigured!** | ||
|
|
||
| 2. **Manual React + Vite setup:** | ||
|
|
||
| You can also install [React + Vite](https://vite.dev/guide/), or use any other React-based framework (e.g. Remix, | ||
| Next.js, etc). | ||
| To add `@pixi/react` to an existing React project, simply install the required dependencies: |
Collaborator
There was a problem hiding this comment.
PixiJs Create actually provides the --template flag which can greatly simplify these instructions:
Suggested change
| **If you want to start a new React project from scratch, we recommend one of the following options:** | |
| 1. **Use the official [CLI tool to create PixiJS](https://pixijs.io/create-pixi/) projects, and choose the React | |
| template:** | |
| Select the React template from Framework Templates: | |
| ```bash | |
| ? Select a type of template: › - Use arrow-keys. Return to submit. | |
| Bundler Templates | |
| ❯ Framework Templates | |
| Creation Templates | |
| Extension | |
| ✔ Select a type of template: › Framework Templates | |
| ? Select a variant: › - Use arrow-keys. Return to submit. | |
| ❯ React | |
| ``` | |
| **This will create a new React + Vite project, with Pixi.js and `@pixi/react` already preconfigured!** | |
| 2. **Manual React + Vite setup:** | |
| You can also install [React + Vite](https://vite.dev/guide/), or use any other React-based framework (e.g. Remix, | |
| Next.js, etc). | |
| To add `@pixi/react` to an existing React project, simply install the required dependencies: | |
| If you want to start a new React project from scratch, we recommend using [PixiJS Create](https://pixijs.io/create-pixi/) with the PixiJS React template: | |
| ```bash | |
| npm create pixi.js@latest pixi-project -- --template framework-react | |
| ``` | |
| If you prefer to setup your project manually, or you're installing in an existing project, PixiJS React can be installed via your package manager: |
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
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.
Improve README installation description