|
1 | | -# 2025-2026 |
| 1 | +<!-- PROJECT SHIELDS --> |
| 2 | +<!-- |
| 3 | +*** I'm using markdown "reference style" links for readability. |
| 4 | +*** Reference links are enclosed in brackets [ ] instead of parentheses ( ). |
| 5 | +*** See the bottom of this document for the declaration of the reference variables |
| 6 | +*** for contributors-url, forks-url, etc. This is an optional, concise syntax you may use. |
| 7 | +*** https://www.markdownguide.org/basic-syntax/#reference-style-links |
| 8 | +--> |
| 9 | +<div align="left"> |
2 | 10 |
|
3 | | -Gear Slingers robot code for Push Back (2024-2025 Season) |
| 11 | +[![Contributors][contributors-shield]][contributors-url] |
| 12 | +[![Forks][forks-shield]][forks-url] |
| 13 | +[![Stargazers][stars-shield]][stars-url] |
| 14 | + |
| 15 | +</div> |
| 16 | + |
| 17 | +<a href="https://github.com/CalPolyVEX/2025-2026"> |
| 18 | + <img alt="Gear Slingers Logo" src="assets/img/logo.png" align="right" width="150"> |
| 19 | +</a> |
| 20 | + |
| 21 | +<div align="left"> |
| 22 | + <h1><em><a href="https://github.com/CalPolyVEX/2025-2026">~2025-2026</a></em></h1> |
| 23 | +</div> |
| 24 | + |
| 25 | +<!-- ABOUT THE PROJECT --> |
| 26 | + |
| 27 | +Gear Slingers robot code for Push Back (2024-2025 Season). |
| 28 | + |
| 29 | +### Built With |
| 30 | + |
| 31 | +[![C++][C++-shield]][C++-url] |
| 32 | +[![GNU Make][GNU-Make-shield]][GNU-Make-url] |
| 33 | + |
| 34 | +<!-- GETTING STARTED --> |
| 35 | + |
| 36 | +## Getting Started |
| 37 | + |
| 38 | +### Prerequisites |
| 39 | + |
| 40 | +Before attempting to build this project, make sure you have [PROS](https://pros.cs.purdue.edu) installed on your machine. |
| 41 | + |
| 42 | +### Installation |
| 43 | + |
| 44 | +To get a local copy of the project up and running on your machine, follow these simple steps: |
| 45 | + |
| 46 | +1. Clone the project repository |
| 47 | + |
| 48 | + ```sh |
| 49 | + git clone https://github.com/CalPolyVEX/2025-2026.git |
| 50 | + cd 2025-2026/ |
| 51 | + ``` |
| 52 | + |
| 53 | +2. Build the package |
| 54 | + |
| 55 | + ```sh |
| 56 | + pros make |
| 57 | + ``` |
| 58 | + |
| 59 | +3. Run the package node |
| 60 | + |
| 61 | + ```sh |
| 62 | + pros upload |
| 63 | + pros run |
| 64 | + ``` |
| 65 | + |
| 66 | +<!-- PROJECT FILE STRUCTURE --> |
| 67 | + |
| 68 | +## Project Structure |
| 69 | + |
| 70 | +```sh |
| 71 | +2025-2026/ |
| 72 | +├── include/ - project header files |
| 73 | +├── src/ - project source files |
| 74 | +│ └── main.cpp - Entry point, main function |
| 75 | +├── Makefile - Makefile build script |
| 76 | +├── LICENSE - project license |
| 77 | +└── README.md - you are here |
| 78 | +``` |
| 79 | + |
| 80 | +## License |
| 81 | + |
| 82 | +The source code for this project is distributed under the terms of the MIT License, as we firmly believe that collaborating on free and open-source software fosters innovations that mutually and equitably beneficial to both collaborators and users alike. See [`LICENSE`](./LICENSE) for details and more information. |
| 83 | + |
| 84 | +<!-- MARKDOWN LINKS & IMAGES --> |
| 85 | +<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links --> |
| 86 | + |
| 87 | +[contributors-shield]: https://img.shields.io/github/contributors/Kaweees/ros2.svg?style=for-the-badge |
| 88 | +[contributors-url]: https://github.com/CalPolyVEX/2025-2026/graphs/contributors |
| 89 | +[forks-shield]: https://img.shields.io/github/forks/CalPolyVEX/2025-2026.svg?style=for-the-badge |
| 90 | +[forks-url]: https://github.com/CalPolyVEX/2025-2026/network/members |
| 91 | +[stars-shield]: https://img.shields.io/github/stars/CalPolyVEX/2025-2026.svg?style=for-the-badge |
| 92 | +[stars-url]: https://github.com/CalPolyVEX/2025-2026/stargazers |
| 93 | + |
| 94 | +<!-- MARKDOWN SHIELD BAGDES & LINKS --> |
| 95 | +<!-- https://github.com/Ileriayo/markdown-badges --> |
| 96 | +[C++-shield]: https://img.shields.io/badge/C++-%23008080.svg?style=for-the-badge&logo=c%2B%2B&logoColor=004482&labelColor=222222&color=004482 |
| 97 | +[C++-url]: https://isocpp.org/ |
| 98 | +[GNU-Make-shield]: https://img.shields.io/badge/GNU%20Make-%23008080.svg?style=for-the-badge&logo=gnu&logoColor=A42E2B&labelColor=222222&color=A42E2B |
| 99 | +[GNU-Make-url]: https://www.gnu.org/software/make/ |
0 commit comments