Clean up README getting started a bit #2664
Conversation
Helps address #2663. More updates needed, but this is a nice start.
| Note: | ||
|
|
||
| - Navigation persistence is OFF by default in production. | ||
| - Error boundary is set to 'always' display by default. |
There was a problem hiding this comment.
I think the navigation persistence note is wrong, and the error boundary one seems unnecessary to me.
|
|
||
| ### Troubleshooting | ||
|
|
||
| The above commands may fail with various errors, depending on your operating system and dependency versions. Some troubleshooting steps to follow: | ||
|
|
||
| - Uninstall global versions of the Ignite CLI via `npm uninstall -g ignite-cli` and use the CLI via `npx ignite-cli` | ||
| - Make sure you are using a reasonably recent version of Node. This can be checked via the `node --version` command. If you require multiple Node versions on your system, install `nvm`, and then run `nvm install --lts`. At the time of writing, Node LTS is v16.x.x. | ||
| - Make sure you are using a reasonably recent version of Node. This can be checked via the `node --version` command. If you require multiple Node versions on your system, install `nvm`, and then run `nvm install --lts`. At the time of writing, Node LTS is v20.x.x. |
There was a problem hiding this comment.
Should we recommend asdf instead of nvm here?
There was a problem hiding this comment.
I think it's pretty 50/50. I've been using nvm without any issues.
I know @joshuayoes and @morganick lean on asdf
There was a problem hiding this comment.
I definitely vote for asdf
| @@ -55,10 +55,10 @@ Ignite also comes with a [component library](./docs/boilerplate/app/components/C | |||
|
|
|||
| Prerequisites: | |||
|
|
|||
| - For [Expo-powered React Native apps](https://expo.io/), no prerequisites are necessary ([why choose Expo?](https://medium.com/@adhithiravi/building-react-native-apps-expo-or-not-d49770d1f5b8)) | |||
| - For vanilla React Native, make sure you're set up for React Native by following [the official documentation](https://reactnative.dev/docs/environment-setup). | |||
There was a problem hiding this comment.
Removed these distinctions, as I don't think they're that necessary.
|
|
||
| If you'd like to follow a tutorial, check out [this one from Robin Heinze](https://shift.infinite.red/creating-a-trivia-app-with-ignite-bowser-part-1-1987cc6e93a1). _Note that this was created for a previous version of Ignite -- we are working on updating it!_ | ||
|
|
||
| ## Generators |
There was a problem hiding this comment.
I agree with 86ing this. I've been using and developing on ignite since the very beginning and i've never actually used a generator.
There was a problem hiding this comment.
@markrickert I still think they're useful. I just don't think they're important to call out so specifically in the README.
|
🎉 This PR is included in version 9.6.3 🎉 The release is available on: Your semantic-release bot 📦🚀 |
Helps address #2663.
More updates needed, but this is a nice start.