diff --git a/.idea/codeStyles/codeStyleConfig.xml b/.idea/codeStyles/codeStyleConfig.xml index 79ee123..41aee02 100644 --- a/.idea/codeStyles/codeStyleConfig.xml +++ b/.idea/codeStyles/codeStyleConfig.xml @@ -1,5 +1,5 @@ - \ No newline at end of file diff --git a/INSTALL.md b/INSTALL.md index 8821951..836024e 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -76,6 +76,7 @@ public class MeepMeepTesting { Step-9 1 2. Click `Edit Configurations` + Step-9 2 3. Click on the "+" symbol in the top left of the window diff --git a/MIGRATING.md b/MIGRATING.md new file mode 100644 index 0000000..3527f40 --- /dev/null +++ b/MIGRATING.md @@ -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 + Step-5 + +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 + Step-7 + +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! 🎉 \ No newline at end of file diff --git a/README.md b/README.md index baa3ce1..dd80af6 100644 --- a/README.md +++ b/README.md @@ -4,11 +4,11 @@ ![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) @@ -16,7 +16,11 @@ ## 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)