From 45c93810ff015d0498f625006c4122de237a616c Mon Sep 17 00:00:00 2001 From: Rushi Patel Date: Mon, 15 Jul 2024 21:00:06 -0700 Subject: [PATCH] Modified readme --- README.md | 99 ++++++++++++++++++++++++++++++++++--------------------- 1 file changed, 61 insertions(+), 38 deletions(-) diff --git a/README.md b/README.md index 58beeac..6808f7c 100644 --- a/README.md +++ b/README.md @@ -1,70 +1,93 @@ -# Getting Started with Create React App +# Black Knights Robotics | Team 2036 -This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app). +Welcome to the repository for the Black Knights Robotics website, the official site for FIRST Robotics Team #2036, The Black Knights. This project is built using [Create React App](https://github.com/facebook/create-react-app). -## Available Scripts +## Project Overview -In the project directory, you can run: +This is the official website for the Black Knights Robotics team, based out of the Boulder Valley School District in Boulder, Colorado. The website provides information about our team, our projects, and our participation in FIRST Robotics competitions. -### `npm start` +## Table of Contents -Runs the app in the development mode.\ -Open [http://localhost:3000](http://localhost:3000) to view it in your browser. +- [Project Overview](#project-overview) +- [Getting Started](#getting-started) +- [Available Scripts](#available-scripts) +- [Learn More](#learn-more) +- [Meta Tags and SEO](#meta-tags-and-seo) +- [Deployment](#deployment) -The page will reload when you make changes.\ -You may also see any lint errors in the console. +## Getting Started -### `npm test` +This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app). To get started with the project, follow these steps: -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. +1. **Clone the repository:** -### `npm run build` + ```sh + git clone https://github.com/your-repository/black-knights + ``` -Builds the app for production to the `build` folder.\ -It correctly bundles React in production mode and optimizes the build for the best performance. +2. ** Navigate to the project directory: ** + cd black-knights -The build is minified and the filenames include the hashes.\ -Your app is ready to be deployed! +3. ** Install the dependencies: ** + npm install + +4. Start the development server: + npm start -See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information. -### `npm run eject` +Available Scripts +In the project directory, you can run: -**Note: this is a one-way operation. Once you `eject`, you can't go back!** +npm start +Runs the app in development mode. +Open http://localhost:3000 to view it in your browser. -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. +The page will reload when you make changes. +You may also see any lint errors in the console. -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. +npm test +Launches the test runner in the interactive watch mode. +See the section about running tests for more information. -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. +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! -## Learn More +See the section about deployment for more information. -You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started). +npm run eject +Note: this is a one-way operation. Once you eject, you can't go back! -To learn React, check out the [React documentation](https://reactjs.org/). +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. -### Code Splitting +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. -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) +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. -### Analyzing the Bundle Size +Learn More +You can learn more in the Create React App documentation. -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) +To learn React, check out the React documentation. -### Making a Progressive Web App +Code Splitting +This section has moved here: https://facebook.github.io/create-react-app/docs/code-splitting -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) +Analyzing the Bundle Size +This section has moved here: https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size -### Advanced Configuration +Making a Progressive Web App +This section has moved here: https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app -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) +Advanced Configuration +This section has moved here: https://facebook.github.io/create-react-app/docs/advanced-configuration -### Deployment +Deployment +This section has moved here: https://facebook.github.io/create-react-app/docs/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 -### `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)