Skip to content

frc-862/lightning

Repository files navigation

Common Library

Build Build Samples
Javadoc GitHub Package Registry Version

Description

This repository contains base code for Team 862's FRC robots.

Getting Started

To add the library to a WPILib Robot Project, make sure the project has all the necessary files in vendordeps/ as seen here.

You must also set up the following dependency repository in your build.gradle.

repositories {
    maven {
        name = "GitHubPackages"
        url = "https://maven.pkg.github.com/frc-862/lightning"
        credentials {
            username = project.findProperty("gpr.user")
            password = project.findProperty("gpr.key")
        }
    }
}

You should set your ~/.gradle/gradle.properties (Unix) or %HOMEPATH%\.gradle\gradle.properties (Windows) file to contain your username as well as a GitHub Personal Access Token

gpr.user=<your-username>
gpr.key=<your-personal-access-token>

Note that you do not need to be a member of the @frc-862 organization to have access to this project.

Lastly, you will need to add the library as a dependency as shown below

dependencies {
    implementation 'com.lightningrobotics:common:<version>'
}

The latest version of this repository (for <version> above) is Latest Version.

Contributing

Releases

To publish a new version, this action must be run. The action requires the desired version number and release title.