Updated README

This commit is contained in:
Vojtěch Struhár 2021-12-08 20:41:33 +01:00
parent 10a974209c
commit aa4052f870
2 changed files with 15 additions and 63 deletions

View File

@ -1,70 +1,22 @@
# Getting Started with Create React App # Steam Review Template
This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app). This is a tool to simplify the creation of copy-pasta reviews that are somewhat popular on Steam. The categories and options are not from my head, I just copied them from somewhere. There are some minor variations on some of the options, but this is the typical rundown.
## Available Scripts ![tonym8xd's review of AC Odyssey generated by this tool](./Review-screenshot.png)
In the project directory, you can run: ## Usage
### `npm start` You just tick all the boxes that you want, the output should look something like this:
Runs the app in the development mode.\ ```
Open [http://localhost:3000](http://localhost:3000) to view it in the browser. ---{ PC Requirements }---
☐ Check if you can run paint
☐ Potato
☐ Decent
☐ Fast
☑ Rich boi
☐ Ask NASA if they have a spare computer
```
The page will reload if you make edits.\ It will generate with a line on the bottom that gives me credit. I would appreciate it if you left it there, but you don't have to if you don't like it :)
You will also see any lint errors in the console.
### `npm test`
Launches the test runner in the interactive watch mode.\
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
### `npm run build`
Builds the app for production to the `build` folder.\
It correctly bundles React in production mode and optimizes the build for the best performance.
The build is minified and the filenames include the hashes.\
Your app is ready to be deployed!
See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
### `npm run eject`
**Note: this is a one-way operation. Once you `eject`, you cant go back!**
If you arent satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point youre on your own.
You dont have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldnt feel obligated to use this feature. However we understand that this tool wouldnt be useful if you couldnt customize it when you are ready for it.
## Learn More
You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
To learn React, check out the [React documentation](https://reactjs.org/).
### Code Splitting
This section has moved here: [https://facebook.github.io/create-react-app/docs/code-splitting](https://facebook.github.io/create-react-app/docs/code-splitting)
### Analyzing the Bundle Size
This section has moved here: [https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size](https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size)
### Making a Progressive Web App
This section has moved here: [https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app](https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app)
### Advanced Configuration
This section has moved here: [https://facebook.github.io/create-react-app/docs/advanced-configuration](https://facebook.github.io/create-react-app/docs/advanced-configuration)
### Deployment
This section has moved here: [https://facebook.github.io/create-react-app/docs/deployment](https://facebook.github.io/create-react-app/docs/deployment)
### `npm run build` fails to minify
This section has moved here: [https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify](https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify)

BIN
Review-screenshot.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 200 KiB