diff --git a/License.md b/License.md new file mode 100644 index 0000000..8a298fd --- /dev/null +++ b/License.md @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2022 Jarhead20 + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md new file mode 100644 index 0000000..cc93feb --- /dev/null +++ b/README.md @@ -0,0 +1,39 @@ +# RRPathGen + +RRPathGen is a tool to generate [Road Runner](https://github.com/acmerobotics/road-runner) paths. + +## Installation (Jar) + +1. Download the jar from the releases page. +2. Run the jar from the command line `java -jar .\RRPathGen-1.0.jar` + + +## Installation (Intellij) + +1. Clone the repo `git clone https://github.com/Jarhead20/RRPathGen.git` +2. Run the Main file +3. Copy your previous autonomous java files to resources and rename the file to import to import the previous splines (might not work unless it only has splineTo's and displacement markers. + +## Usage + +| Key Bind | Action | +|---------------------|-------------------------| +| Left Click | Add New Point | +| Left Drag (Point) | Drags Selected Point | +| Right Click (Point) | Edits The Point | +| Alt Left Click | Change Heading | +| Left Arrow | Next Path | +| Right Arrow | Previous Path | +| R | Reverse Robot Direction | +| Esc | Escape | + +## Acknowledgements +The inspiration from this project came from Technic Bots' [Blitz](https://technicbots.com/Blitz) app.
+The field images were aquired from [MeepMeep](https://github.com/NoahBres/MeepMeep).
+And a big thank you to [Ryan Brott](https://github.com/rbrott) for helping me with the spline implementation. + +## Contributing +Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change. + +## License +[MIT](https://choosealicense.com/licenses/mit/)