-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
58 additions
and
74 deletions.
There are no files selected for viewing
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,68 +1,39 @@ | ||
| This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app). | ||
| # Take Aim | ||
|
|
||
| ## Available Scripts | ||
| Take Aim is a web based dry fire system. Using a laser cartridge put into a gun, a webcam, and a projector, you can get immediate feedback on your dry firing. | ||
|
|
||
| In the project directory, you can run: | ||
| ## Getting Started | ||
|
|
||
| ### `yarn start` | ||
| These instructions will get you a copy of the project up and running on your local machine for development purposes. See deployment for notes on how to deploy the project on a live system. | ||
|
|
||
| Runs the app in the development mode.<br /> | ||
| Open [http://localhost:3000](http://localhost:3000) to view it in the browser. | ||
|
|
||
| The page will reload if you make edits.<br /> | ||
| You will also see any lint errors in the console. | ||
| ### Installing | ||
|
|
||
| ### `yarn test` | ||
| The install dependencies run `npm install`. | ||
|
|
||
| Launches the test runner in the interactive watch mode.<br /> | ||
| See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information. | ||
| To run Take Aim run `npm start`. | ||
|
|
||
| ### `yarn build` | ||
|
|
||
| Builds the app for production to the `build` folder.<br /> | ||
| It correctly bundles React in production mode and optimizes the build for the best performance. | ||
| ## Deployment | ||
|
|
||
| The build is minified and the filenames include the hashes.<br /> | ||
| Your app is ready to be deployed! | ||
| To create a production build, run `npm run build`. Copy the contents of the `build` folder to your web host. | ||
|
|
||
| See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information. | ||
| ## Built With | ||
|
|
||
| ### `yarn eject` | ||
| * [OpenCV.js](https://docs.opencv.org/3.4/d5/d10/tutorial_js_root.html) - Computer Vision Framework | ||
| * [React](https://reactjs.org/) - Web Framework | ||
|
|
||
| **Note: this is a one-way operation. Once you `eject`, you can’t go back!** | ||
| ## Contributing | ||
|
|
||
| If you aren’t 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. | ||
| Please read [CONTRIBUTING.md](https://gist.github.com/PurpleBooth/b24679402957c63ec426) for details on our code of conduct, and the process for submitting pull requests to us. | ||
|
|
||
| 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 you’re on your own. | ||
| ## Authors | ||
|
|
||
| You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it. | ||
| * **Daniel Becker** - [dbecker1](https://github.com/dbecker1) | ||
|
|
||
| ## Learn More | ||
| See also the list of [contributors](https://github.com/your/project/contributors) who participated in this project. | ||
|
|
||
| You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started). | ||
| ## License | ||
|
|
||
| To learn React, check out the [React documentation](https://reactjs.org/). | ||
| This project is licensed under the GNU AGPL-3.0 License - see the [LICENSE.md](LICENSE.md) file for details | ||
|
|
||
| ### Code Splitting | ||
|
|
||
| This section has moved here: 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 | ||
|
|
||
| ### Making a Progressive Web App | ||
|
|
||
| This section has moved here: 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 | ||
|
|
||
| ### Deployment | ||
|
|
||
| This section has moved here: https://facebook.github.io/create-react-app/docs/deployment | ||
|
|
||
| ### `yarn build` fails to minify | ||
|
|
||
| This section has moved here: https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify |