Initial commit from weevil new --template basic
This commit is contained in:
57
README.md
57
README.md
@@ -1,28 +1,53 @@
|
||||
# chute-drive
|
||||
|
||||
FTC Robot Project generated by Weevil v1.1.0-rc1
|
||||
FTC Robot project created with Weevil 1.1.0-rc1 on 2026-02-04T03:57:40.088970052+00:00.
|
||||
|
||||
## Getting Started
|
||||
|
||||
This is a minimal FTC robot project. Add your robot code in:
|
||||
- `src/main/java/robot/opmodes/` - OpModes for TeleOp and Autonomous
|
||||
- `src/main/java/robot/subsystems/` - Robot subsystems
|
||||
- `src/main/java/robot/hardware/` - Hardware abstractions
|
||||
|
||||
## Building
|
||||
|
||||
## Quick Start
|
||||
```bash
|
||||
# Test your code (runs on PC, no robot needed)
|
||||
./gradlew test
|
||||
# Setup environment (first time only)
|
||||
weevil setup
|
||||
|
||||
# Build and deploy (Linux/Mac)
|
||||
./build.sh
|
||||
./deploy.sh
|
||||
# Build APK
|
||||
weevil build
|
||||
|
||||
# Build and deploy (Windows)
|
||||
build.bat
|
||||
deploy.bat
|
||||
# Deploy to robot
|
||||
weevil deploy
|
||||
```
|
||||
|
||||
## Project Structure
|
||||
|
||||
- `src/main/java/robot/` - Your robot code
|
||||
- `src/test/java/robot/` - Unit tests (run on PC)
|
||||
```
|
||||
chute-drive/
|
||||
├── src/
|
||||
│ ├── main/java/robot/
|
||||
│ │ ├── hardware/ # Hardware interfaces
|
||||
│ │ ├── subsystems/ # Robot subsystems
|
||||
│ │ └── opmodes/ # TeleOp and Autonomous
|
||||
│ └── test/java/robot/ # Unit tests
|
||||
├── build.gradle # Build configuration
|
||||
└── README.md # This file
|
||||
```
|
||||
|
||||
## Development Workflow
|
||||
## Next Steps
|
||||
|
||||
1. Write code in `src/main/java/robot/`
|
||||
2. Test locally: `./gradlew test`
|
||||
3. Deploy: `./deploy.sh` (or `deploy.bat` on Windows)
|
||||
1. Add your robot hardware in `src/main/java/robot/hardware/`
|
||||
2. Create subsystems in `src/main/java/robot/subsystems/`
|
||||
3. Write OpModes in `src/main/java/robot/opmodes/`
|
||||
4. Test and deploy!
|
||||
|
||||
## Documentation
|
||||
|
||||
- [Weevil Documentation](https://docs.weevil.dev)
|
||||
- [FTC SDK Documentation](https://ftc-docs.firstinspires.org)
|
||||
|
||||
---
|
||||
|
||||
Created with [Weevil](https://weevil.dev) - FTC Project Generator
|
||||
|
||||
Reference in New Issue
Block a user