From 67622aa8604af4adb0edf48f807696ac861d6e3e Mon Sep 17 00:00:00 2001 From: GZod01 Date: Sun, 10 Mar 2024 16:22:38 +0100 Subject: [PATCH] add docs to Readme.md --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/README.md b/README.md index 9d5f74a..806a225 100644 --- a/README.md +++ b/README.md @@ -3,3 +3,20 @@ ## Requirements Work only with Rev Robotics Control Hub designed for [FIRSTĀ®](https://firstinspires.org) Tech Challenge competitions +## How To use? +Download the code and use it... + +## How To Use the FTC2024WeRobotControl tool? +In your robot code import the class, then in the runOpMode function of your robot code create instance of the FTC2024WeRobotControl (e.g. `FTC2024WeRobotControl robot = new FTC2024WeRobotControl()`) then you can use this instance to move the robot. + +E.G. +```java +double speed_for_motors = 1.0; +double number_or_tiles = 3.0; +double angle_to_rotate = 50; // in degrees +FTC2024WeRobotControl robot = new FTC2024WeRobotControl() +robot.forward(number_or_tiles, speed_for_motors); +robot.rotate(angle_to_rotate, speed_for_motors); +``` + +Read the FTC2024WeRobotControl.java file to get complete docs.