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.

Sign up for GitHub

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

Add Migration Guide, Update other markdown files. #9

Merged
merged 1 commit into from
Sep 25, 2024
Merged

Add Migration Guide, Update other markdown files. #9

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion .idea/codeStyles/codeStyleConfig.xml
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions INSTALL.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,7 @@ public class MeepMeepTesting {
<img width="416" alt="Step-9 1" src="https://github.com/user-attachments/assets/d8b8b370-0b3c-466d-b727-821e36b4636e">

2. Click `Edit Configurations`

<img width="373" alt="Step-9 2" src="https://github.com/user-attachments/assets/51f3a279-3bd6-4060-bfa7-4bc9d1313a10">

3. Click on the "+" symbol in the top left of the window
Expand Down
18 changes: 18 additions & 0 deletions MIGRATING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Migrating from [NoahBres/MeepMeep](https://github.com/NoahBres/MeepMeep)
1. Locate and open the build.gradle file for the MeepMeep module
<img width="508" alt="Step-5" src="https://github.com/user-attachments/assets/4857d3f0-1e5b-4bc5-bec8-158cb2b49ecf">

2. Replace the `dependencies` section with the following:

```
dependencies {
implementation 'com.github.rh-robotics:MeepMeep:v1.0.0'
}
```

3. When prompted by Android Studio, click on `Sync Now` to update the project with the new dependency
<img width="965" alt="Step-7" src="https://github.com/user-attachments/assets/9453647d-1f33-44f3-9072-a329ddded062">

4. In your main MeepMeep class, replace any import statements that reference `com.noahbres.meepmeep` with `org.rowlandhall.meepmeep`

5. You have now successfully migrated from NoahBres/MeepMeep to rh-robotics/MeepMeep! 🎉
8 changes: 6 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,19 +4,23 @@
![Instagram Badge](https://img.shields.io/badge/%40rh--iron--lions-yellow?style=for-the-badge&logo=instagram&logoColor=%23edbe28&label=Instagram&labelColor=%23676767&color=%23edbe28&link=https%3A%2F%2Finstagram.com%2Frh-iron-lions)
![Email Badge](https://img.shields.io/badge/ironlions19922%40gmail.com-yellow?style=for-the-badge&logo=gmail&logoColor=%23edbe28&label=Email&labelColor=%23676767&color=%23edbe28&link=mailto%3Aironlions19922%40gmail.com)

---

## Table of Contents

- [Installation](#installation)
- [Migrating from NoahBres](#migrating-from-noahbresmeepmeep)
- [Full Documentation (Kotlin Docs)](#full-documentation-kotlin-docs)
- [Misc Info](#extra-tips)
- [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)
See [INSTALL.md](./INSTALL.md)

## Migrating from NoahBres/MeepMeep

See [MIGRATING.md](./MIGRATING.md)

## Full Documentation (Kotlin Docs)

Expand Down
Loading