Skip to content

Commit

Permalink
Format Install.md & Readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
DragonDev07 committed Sep 24, 2024
1 parent 50cd35b commit c6624fa
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 9 deletions.
3 changes: 3 additions & 0 deletions INSTALL.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
# Step-by-Step Installation Guide (Android Studio)

1. In Android Studio, click on the "FtcRobotController" Module, then right-click on the FtcRobotController folder and click `New > Module`
<img width="903" alt="Step-1" src="https://github.com/user-attachments/assets/8c53e58a-d7e7-464c-bf6a-519321db22fd">

Expand Down Expand Up @@ -70,6 +71,7 @@ public class MeepMeepTesting {
```

9. Create a run configuration for Android Studio.

1. First, click on the drop down menu on the top bar of Android Studio, where it says "TeamCode" with a little Android logo next to it
<img width="416" alt="Step-9 1" src="https://github.com/user-attachments/assets/d8b8b370-0b3c-466d-b727-821e36b4636e">

Expand All @@ -95,4 +97,5 @@ public class MeepMeepTesting {
<img width="1073" alt="Step-9 8" src="https://github.com/user-attachments/assets/8ec43003-c50b-4dda-84a3-c6aa66d23182">

9. It will now automatically switch to that Run/Debug Configuration profile

10. If at any point you would like to build code onto your Control Hub or Phone, then click the Run/Debug configuration profile at the top to open the dropdown menu and select TeamCode. Perform the same steps to switch back to "MeepMeep"
20 changes: 11 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,15 @@
- [Installation](#installation)
- [Full Documentation (Kotlin Docs)](#full-documentation-kotlin-docs)
- [Misc Info](#extra-tips)
- [Poor Performance Fix](#poor-performance-fix)
- [Default Bot Constraints](#default-bot-constraints)
- [Poor Performance Fix](#poor-performance-fix)
- [Default Bot Constraints](#default-bot-constraints)

## Installation

See [INSTALL.md](https://github.com/rh-robotics/MeepMeep/blob/master/INSTALL.md)

## Full Documentation (Kotlin Docs)

See the full Kotlin documentation on [GitHub Sites](https://rh-robotics.github.io/MeepMeep)

## Extra Tips
Expand Down Expand Up @@ -47,15 +49,15 @@ MeepMeep is hosted on JitPack. This allows the user to pull dependencies from an
the dependency version in build.gradle to do so.

- Pull from a specific tagged version (same as install instructions)
- `implementation 'com.github.rh-robotics:MeepMeep:1.0.0'`
- `1.0.0` can be replaced with whatever version specified on
the [GitHub releases page](https://github.com/NoahBres/MeepMeep/releases)
- `implementation 'com.github.rh-robotics:MeepMeep:1.0.0'`
- `1.0.0` can be replaced with whatever version specified on
the [GitHub releases page](https://github.com/NoahBres/MeepMeep/releases)
- Pull from whatever the latest commit on the master branch is
- `implementation 'com.github.rh-robotics:MeepMeep:-SNAPSHOT'`
- `implementation 'com.github.rh-robotics:MeepMeep:-SNAPSHOT'`
- Pull from a specific commit
- `implementation 'com.github.rh-robotics:MeepMeep:<commit version ID>'`
- `<commit ID>` is replaced with the ID of the commit. For example "79d123f0c1"
- This is not the full commit hash, rather, the first 10 characters of the commit hash
- `implementation 'com.github.rh-robotics:MeepMeep:<commit version ID>'`
- `<commit ID>` is replaced with the ID of the commit. For example "79d123f0c1"
- This is not the full commit hash, rather, the first 10 characters of the commit hash

### Poor Performance Fix

Expand Down

0 comments on commit c6624fa

Please sign in to comment.