Merge pull request #3 from Arctos6135/develop

Version 0.1.0
Arctos6135 · Nov 8, 2019 · 444dc74 · 444dc74
2 parents b194586 + 895fee4
commit 444dc74
Show file tree

Hide file tree

Showing 14 changed files with 1,129 additions and 0 deletions.
diff --git a/.travis.yml b/.travis.yml
@@ -0,0 +1,41 @@
+language: java
+
+dist: xenial
+
+# Encrypted Ryver webhook URL
+env:
+  global:
+    secure: "nocwDdsM6mLY8besfGRshGQn44ZxaRgsuu00Q0D5T9JUrr3T0zxnh26PJwSxJmn02BqyYgmYUlNieb0h4cev4YOvuLaJxkTTP6TrUwHFFh6OQZp5rUVRR8Fbajje24sSKKJxbjR3nNqCb1cvpeZ4uks+rEc90LML9qO/L5XC9foYEHw5tTwp/zKThzhDJLkTs3KRpA4dIwYfXCpLpPzEbWpPNjouuBqBDHwJqPsqb4ps64hsybckEK3J7JR8FbWPWPOW4IFM0rpF6yjWZZwLbpYArX2FwjmZaR1Fdge4ECXHdS3bmiZS15G4LpKjOuKUYeV7E9dTVmQmkaGb2xr2aSnVVtHz5eDneDxP5pFYdA5X9uw25023BCONZ9YLDBK0H2TQOVBYHvMc33cnjAITgWHnnWh/vLlZ9Gb79qRkuOZiITT5Y0qs8XtctWnPhELWKvk7XHkCFeaunwWx9mnYwb6JpdlRxpsvWEVAgmiCwlgdTstK9h5fFf2fKu/1lh77EO/N7BYZMlTdb4nd9uWscfbcEr1G8TzOZCaA9ScbW4rKkMysltB3NPiKcCS+HuOX8qBxQ6SacbiEp+Wie05Cp2sDhUCWOyBx3Q9B45w6QuKbtb+H0kAZjacrsM5ycKYhnsWRTL5Ga76AGEaH6odSnA6Wx064pzJ+2/3aUPBIN9s="
+
+install: 
+  # chmod the wrapper to be executable
+  - chmod +x ./gradlew
+  - ./gradlew --version
+
+script:
+  - ./gradlew build -s --rerun-tasks
+
+# Enable gradle cache
+before_cache:
+  - rm -f  $HOME/.gradle/caches/modules-2/modules-2.lock
+  - rm -fr $HOME/.gradle/caches/*/plugin-resolution/
+
+cache:
+  directories:
+    - $HOME/.gradle/caches/
+    - $HOME/.gradle/wrapper/
+
+after_success:
+  - export SHORT_COMMIT=${TRAVIS_COMMIT:0:7}
+  - >
+    curl --request 'POST' 
+    --header 'Content-Type: text/plain; charset=utf-8' 
+    --data "&#9989; **SUCCESS** &#9989; The latest commit pushed to **RobotLib** (commit *$SHORT_COMMIT* on branch *$TRAVIS_BRANCH*) has [**passed** CI checks]($TRAVIS_JOB_WEB_URL)!"
+    $WEBHOOK_URL
+after_failure:
+  - export SHORT_COMMIT=${TRAVIS_COMMIT:0:7}
+  - >
+    curl --request 'POST' 
+    --header 'Content-Type: text/plain; charset=utf-8' 
+    --data "&#10060; **ERROR** &#10060; The latest commit pushed to **RobotLib** (commit *$SHORT_COMMIT* on branch *$TRAVIS_BRANCH*) has [**failed** CI checks]($TRAVIS_JOB_WEB_URL)!" 
+    $WEBHOOK_URL
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 FRC Team Arctos 6135
+
+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
@@ -0,0 +1,43 @@
+# RobotLib
+[![master Build Status](https://img.shields.io/travis/com/Arctos6135/RobotLib/master.svg?label=build%20%28master%29&logo=travis)](https://travis-ci.com/Arctos6135/RobotLib/branches)&nbsp;
+[![Latest Build Status](https://img.shields.io/travis/com/Arctos6135/RobotLib.svg?label=build%20%28latest%29&logo=travis)](https://travis-ci.com/Arctos6135/RobotLib)&nbsp;
+[![Latest Stable Release](https://img.shields.io/github/tag/Arctos6135/RobotLib.svg?logo=data:image/svg%2bxml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiBzdGFuZGFsb25lPSJubyI/Pgo8IURPQ1RZUEUgc3ZnIFBVQkxJQyAiLS8vVzNDLy9EVEQgU1ZHIDIwMDEwOTA0Ly9FTiIKICJodHRwOi8vd3d3LnczLm9yZy9UUi8yMDAxL1JFQy1TVkctMjAwMTA5MDQvRFREL3N2ZzEwLmR0ZCI+CjxzdmcgdmVyc2lvbj0iMS4wIiB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciCiB3aWR0aD0iMzIuMDAwMDAwcHQiIGhlaWdodD0iMzIuMDAwMDAwcHQiIHZpZXdCb3g9IjggOCAxNi4wMDAwMDAgMTYuMDAwMDAwIgogcHJlc2VydmVBc3BlY3RSYXRpbz0ieE1pZFlNaWQgbWVldCI+Cgo8ZyB0cmFuc2Zvcm09InRyYW5zbGF0ZSgwLjAwMDAwMCwzMi4wMDAwMDApIHNjYWxlKDAuMTAwMDAwLC0wLjEwMDAwMCkiCmZpbGw9IiNGRkZGRkYiIHN0cm9rZT0ibm9uZSI+CjxwYXRoIGQ9Ik05NyAyMjMgYy0xOCAtMTcgLTUgLTYxIDI2IC05MSAzOSAtMzggNDcgLTM5IDc1IC05IDI5IDMxIDI4IDM3IC0xMQo3NSAtMzEgMzAgLTc0IDQyIC05MCAyNXogbTgwIC0zNSBsMzMgLTMyIC0yMiAtMjMgLTIyIC0yMyAtMzMgMzIgYy0zMSAzMCAtNDEKNTcgLTI2IDcxIDE0IDE1IDM4IDYgNzAgLTI1eiIvPgo8cGF0aCBkPSJNMTEwIDIwMCBjMCAtNSA1IC0xMCAxMCAtMTAgNiAwIDEwIDUgMTAgMTAgMCA2IC00IDEwIC0xMCAxMCAtNSAwCi0xMCAtNCAtMTAgLTEweiIvPgo8L2c+Cjwvc3ZnPgo=)](https://github.com/Arctos6135/RobotLib/releases/latest)&nbsp;
+[![MIT License](https://img.shields.io/github/license/Arctos6135/RobotLib.svg?logo=data:image/svg%2bxml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiBzdGFuZGFsb25lPSJubyI/Pgo8IURPQ1RZUEUgc3ZnIFBVQkxJQyAiLS8vVzNDLy9EVEQgU1ZHIDIwMDEwOTA0Ly9FTiIKICJodHRwOi8vd3d3LnczLm9yZy9UUi8yMDAxL1JFQy1TVkctMjAwMTA5MDQvRFREL3N2ZzEwLmR0ZCI+CjxzdmcgdmVyc2lvbj0iMS4wIiB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciCiB3aWR0aD0iMzIuMDAwMDAwcHQiIGhlaWdodD0iMzIuMDAwMDAwcHQiIHZpZXdCb3g9IjggOCAxNi4wMDAwMDAgMTYuMDAwMDAwIgogcHJlc2VydmVBc3BlY3RSYXRpbz0ieE1pZFlNaWQgbWVldCI+Cgo8ZyB0cmFuc2Zvcm09InRyYW5zbGF0ZSgwLjAwMDAwMCwzMi4wMDAwMDApIHNjYWxlKDAuMTAwMDAwLC0wLjEwMDAwMCkiCmZpbGw9IiNGRkZGRkYiIHN0cm9rZT0ibm9uZSI+CjxwYXRoIGQ9Ik0xMzkgMjIzIGMtMSAtNCAtMSAtMTEgMCAtMTUgMCAtNCAtMTAgLTEwIC0yMiAtMTMgLTEzIC00IC0yNCAtMTIKLTI1IC0xOCAwIC03IC00IC0yMiAtNyAtMzQgLTYgLTIwIC00IC0yMyAxOSAtMjMgMjggMCAzMiAxMCAxNiA0MCAtNyAxMyAtNgoxOSA1IDI0IDIzIDggMjEgLTcwIC0yIC04MyAtMTQgLTggLTggLTEwIDI3IC0xMCAzNSAwIDQxIDIgMjggMTAgLTI0IDEzIC0yNgo5MSAtMyA4MyAxMSAtNSAxMiAtMTEgNSAtMjQgLTE2IC0zMCAtMTIgLTQwIDE2IC00MCAyMyAwIDI1IDMgMTkgMjIgLTMgMTMgLTcKMjggLTcgMzUgLTEgNiAtMTIgMTQgLTI1IDE4IC0xMiAzIC0yMiAxMCAtMjAgMTYgMSA3IC00IDE0IC0xMCAxNiAtNyAzIC0xNCAxCi0xNCAtNHogbS0yNCAtNzMgYzMgLTUgLTEgLTEwIC0xMCAtMTAgLTkgMCAtMTMgNSAtMTAgMTAgMyA2IDggMTAgMTAgMTAgMiAwCjcgLTQgMTAgLTEweiBtOTAgMCBjMyAtNSAtMSAtMTAgLTEwIC0xMCAtOSAwIC0xMyA1IC0xMCAxMCAzIDYgOCAxMCAxMCAxMCAyCjAgNyAtNCAxMCAtMTB6Ii8+CjwvZz4KPC9zdmc+Cg==)](https://github.com/Arctos6135/RobotLib/blob/master/LICENSE)
+
+## Overview
+
+RobotLib is the library created and used by Team Arctos containing many common robot utilities to simplify robot programming.
+It contains everything from logging to XBox controller utilities, and much more.
+
+## Usage
+
+### Setup
+
+To use this library, first grab the jar from [the latest release](https://github.com/Arctos6135/RobotLib/releases/latest) and put it somewhere in your robot project, say in the `lib` directory.
+Then, in `build.gradle`, under `dependencies`, add this line: `compile files('path/to/jar')`. Your new `dependencies` should look something like this:
+```groovy
+dependencies {
+    compile wpi.deps.wpilib()
+    compile wpi.deps.vendor.java()
+
+    compile files('lib/RobotLib-0.1.0.jar')
+    
+    nativeZip wpi.deps.vendor.jni(wpi.platforms.roborio)
+    nativeDesktopZip wpi.deps.vendor.jni(wpi.platforms.desktop)
+    testCompile 'junit:junit:4.12'
+}
+```
+
+## Documentation
+All classes in the public API are documented with Javadocs. For every release, you can find the Javadocs as `RobotLib-Doc-<VERSION>.zip`. 
+
+## Thank You to Our Generous Sponsors:
+<img src="https://dynamicmedia.zuza.com/zz/m/original_/3/a/3aae60b3-ff18-4be5-b2b1-e244943a85fb/TDSB_Gallery.png" alt="Toronto District School Board" height="200px"/>
+<img src="https://developer.nordicsemi.com/.webresources/NordicS.jpg" alt="Nordic Semiconductors" height="170px"/>
+<img src="https://upload.wikimedia.org/wikipedia/en/thumb/5/50/SNC-Lavalin_logo.svg/1280px-SNC-Lavalin_logo.svg.png" alt="SNC-Lavalin" height="170px"/>
+<img src="https://user-images.githubusercontent.com/32781310/52970668-acd64780-3382-11e9-857f-85b829690e0c.png" alt="Scotia McLeod" height="200px"/>
+<img src="https://kissmybutton.gr/wp-content/uploads/2017/09/ryver.png" alt="Ryver Inc." height="200px"/>
+<img src="https://user-images.githubusercontent.com/32781310/52224389-eaf94480-2875-11e9-82ba-78ec58cd20cd.png" alt="The Maker Bean Cafe" height="200px"/>
+<img src="http://connecttech.com/logo.jpg" alt="Connect Tech Inc." height="200px"/>
+<img src="https://brafasco.com/media/wysiwyg/HDS_construction_industrial_BF_4C_pos.png" alt="HD Supply Brafasco" height="200px"/>
+<img src="https://encrypted-tbn0.gstatic.com/images?q=tbn:ANd9GcRqnEGnLesUirrtMQfhxLGUTZn2xkVWpbROlvmABI2Nk6HzhD1w" alt="Arbour Memorial" height="200px"/>