Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fill READMEs with helpful(?) information #31

Open
wants to merge 27 commits into
base: main
Choose a base branch
from
Open
Changes from 1 commit
Commits
Show all changes
27 commits
Select commit Hold shift + click to select a range
64d95b1
Update READMEs
anivanchen Apr 6, 2022
1378542
Update limelight README
anivanchen Apr 6, 2022
2cb2fbd
More READMEs and fix typo
anivanchen Apr 6, 2022
35d74f5
MORE READMEs
anivanchen Apr 6, 2022
6871ae1
Start Controls README
anivanchen Apr 6, 2022
6f00594
Update READMEs
anivanchen Apr 6, 2022
9cdc309
Update limelight README
anivanchen Apr 6, 2022
a425c4d
More READMEs and fix typo
anivanchen Apr 6, 2022
955281a
MORE READMEs
anivanchen Apr 6, 2022
cd2ae28
Start Controls README
anivanchen Apr 6, 2022
f78dd0b
Merge branch 'ic/readme-marathon' of https://github.com/stuypulse/stu…
anivanchen Apr 6, 2022
c0762a5
Update READMEs
anivanchen Apr 6, 2022
bf6ba94
Update limelight README
anivanchen Apr 6, 2022
cf4f56e
More READMEs and fix typo
anivanchen Apr 6, 2022
6f4414b
MORE READMEs
anivanchen Apr 6, 2022
ab8ee05
Start Controls README
anivanchen Apr 6, 2022
e3e7c51
Merge branch 'ic/readme-marathon' of https://github.com/stuypulse/stu…
anivanchen Apr 7, 2022
9a991a9
Update READMEs
anivanchen Apr 7, 2022
358cdb9
Update readme.md
anivanchen Apr 7, 2022
5bafd52
Merge branch 'ic/readme-marathon' of https://github.com/stuypulse/stu…
anivanchen Apr 7, 2022
8be77bc
Update control readme
anivanchen Apr 8, 2022
40f48de
Merge branch 'main' into ic/readme-marathon
Sam-Belliveau Aug 23, 2022
be9ff15
Merge branch 'main' into ic/readme-marathon
Sam-Belliveau Aug 23, 2022
6b96d41
Merge branch 'main' into ic/readme-marathon
Sam-Belliveau Aug 23, 2022
7bab963
Merge branch 'main' into ic/readme-marathon
Sam-Belliveau Aug 23, 2022
2382e90
Merge branch 'main' into ic/readme-marathon
Sam-Belliveau Aug 23, 2022
d9c2ab3
Merge branch 'main' into ic/readme-marathon
Sam-Belliveau Aug 23, 2022
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
More READMEs and fix typo
anivanchen committed Apr 7, 2022

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
commit cf4f56e9144799c726ef15f144b674e7e184fb42
2 changes: 1 addition & 1 deletion src/com/stuypulse/stuylib/input/Gamepad.java
Original file line number Diff line number Diff line change
@@ -11,7 +11,7 @@
import edu.wpi.first.wpilibj2.command.button.Button;

/**
* An class for using gamepads with different interfaces. You can implement this class in another
* A class for using gamepads with different interfaces. You can implement this class in another
* file, and then use it with a standard interface.
*
* <p>Any unimplemented buttons will never be triggered, so if a certain controller is missing one,
16 changes: 15 additions & 1 deletion src/com/stuypulse/stuylib/input/gamepads/readme.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,17 @@
# StuyLib Gamepad Implementations

WIP...
Implementations of various gamepads used in FRC robotics

### AutoGamepad

### Logitech

### PS4

### Xbox

### KeyGamepad

### NetKeyGamepad

### SimKeyGamepad
13 changes: 12 additions & 1 deletion src/com/stuypulse/stuylib/input/keyboard/readme.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,14 @@
# StuyLib Network Keyboard

WIP...
### [NetKeyboard](https://github.com/StuyPulse/StuyLib/blob/main/src/com/stuypulse/stuylib/input/keyboard/NetKeyboard.java)

[NetKeyboard](https://github.com/StuyPulse/StuyLib/blob/main/src/com/stuypulse/stuylib/input/keyboard/NetKeyboard.java) implements and simplifies interactions with keyboard information through a network table.

### [NetKeyListener](https://github.com/StuyPulse/StuyLib/blob/main/src/com/stuypulse/stuylib/input/keyboard/NetKeyListener.java)

[NetKeyListener](https://github.com/StuyPulse/StuyLib/blob/main/src/com/stuypulse/stuylib/input/keyboard/NetKeyListener.java) listens for and uploads keyboard events to the keyboard network table.

### [NetKeyWindow](https://github.com/StuyPulse/StuyLib/blob/main/src/com/stuypulse/stuylib/input/keyboard/NetKeyWindow.java)

[NetKeyWindow](https://github.com/StuyPulse/StuyLib/blob/main/src/com/stuypulse/stuylib/input/keyboard/NetKeyWindow.java) opens a Java AWT window and simulates a keyboard with a [NetKeyListener](https://github.com/StuyPulse/StuyLib/blob/main/src/com/stuypulse/stuylib/input/keyboard/NetKeyListener.java) which can be used to control a robot.

20 changes: 18 additions & 2 deletions src/com/stuypulse/stuylib/input/readme.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,19 @@
# StuyLib Gamepad Library
# StuyLib Input Library

WIP...
The Input library contains classes which simplifies gamepad / keyboard input and standardizes the way input is handled and retrieved.

To learn about specific gamepads, [read here](https://github.com/StuyPulse/StuyLib/blob/main/src/com/stuypulse/stuylib/input/gamepads/readme.md).

To learn about keyboard input, [read here](https://github.com/StuyPulse/StuyLib/blob/main/src/com/stuypulse/stuylib/input/keyboard/readme.md).

### [Gamepad](https://github.com/StuyPulse/StuyLib/blob/main/src/com/stuypulse/stuylib/input/Gamepad.java)

[Gamepad](https://github.com/StuyPulse/StuyLib/blob/main/src/com/stuypulse/stuylib/input/Gamepad.java) is a class which standardizes the gamepad interface. It does not do anything by itself and must be extended by other gamepads.

### [GamepadState](https://github.com/StuyPulse/StuyLib/blob/main/src/com/stuypulse/stuylib/input/GamepadState.java)

[GamepadState](https://github.com/StuyPulse/StuyLib/blob/main/src/com/stuypulse/stuylib/input/GamepadState.java) stores the state of a [`Gamepad`](https://github.com/StuyPulse/StuyLib/blob/main/src/com/stuypulse/stuylib/input/Gamepad.java) separated by the different buttons and axis. Yet to be implemented, it can be used to "record" and "play back" gamepad input.

### [SPIGamepad](https://github.com/StuyPulse/StuyLib/blob/main/src/com/stuypulse/stuylib/input/WPIGamepad.java)

The [SPIGamepad](https://github.com/StuyPulse/StuyLib/blob/main/src/com/stuypulse/stuylib/input/WPIGamepad.java) class adds functions which make interactions with WPILib's `Joystick` class simpler.