From e8be43616522f0de75d834e9e8a46bc200de18dd Mon Sep 17 00:00:00 2001 From: Alec-Nesat Colak Date: Wed, 25 Sep 2024 16:21:18 -0400 Subject: [PATCH 1/4] Update README.md for setup and dev pushes --- README.md | 62 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 62 insertions(+) diff --git a/README.md b/README.md index 00284df..0f889df 100644 --- a/README.md +++ b/README.md @@ -57,3 +57,65 @@ The above copyright notice, this permission notice, and its license shall be inc You can find a copy of the GNU General Public License v3 [here](https://www.gnu.org/licenses/)

+ +--- +

🚀 Getting Started

+ +### Prerequisites + +- Android Studio (latest version recommended) +- Java Development Kit (JDK) 11 or higher +- Git + +### Installation + +1. **Clone the repository:** + ```sh + git clone https://github.com/sosauce/CuteMusic.git + cd CuteMusic + ``` + +2. **Open the project in Android Studio:** + - Open Android Studio. + - Select `Open an existing project`. + - Navigate to the `CuteMusic` directory and select it. + +3. **Build the project:** + - Click on `Build` in the top menu. + - Select `Make Project` and ensure there are no errors. + +4. **Run the app:** + - Connect an Android device or use an emulator. + - Click on `Run` in the top menu. + - Select your device and click `OK`. + +### Contributing + +1. **Fork the repository:** + - Click the `Fork` button on the top right of the repository page. + +2. **Create a new branch:** + ```sh + git checkout -b feature/YourFeatureName + ``` + +3. **Make your changes:** + - Implement your feature or bug fix. + - Ensure your code follows the project's coding standards. + +4. **Commit your changes:** + ```sh + git add . + git commit -m "Add feature: YourFeatureName" + ``` + +5. **Push to your fork:** + ```sh + git push origin feature/YourFeatureName + ``` + +6. **Create a Pull Request:** + - Go to the original repository. + - Click on `Pull Requests` and then `New Pull Request`. + - Select your branch and submit the pull request. + From 3a0d3453cabb0a265e452ca7b17f982dbc7528ad Mon Sep 17 00:00:00 2001 From: sosauce <98750531+sosauce@users.noreply.github.com> Date: Thu, 26 Sep 2024 09:57:37 +0200 Subject: [PATCH 2/4] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 00284df..303e51f 100644 --- a/README.md +++ b/README.md @@ -31,7 +31,7 @@

💬 Contact Me

- Discord server: https://discord.gg/c6aCu4yjbu -- Email = sosauce_dev@protonmail.com +- Email: sosauce_dev@protonmail.com ---

❤️ Support

From 11ac483ef487f20390d1b27dbe1dfd9e4c108c3a Mon Sep 17 00:00:00 2001 From: sosauce <98750531+sosauce@users.noreply.github.com> Date: Fri, 27 Sep 2024 17:03:29 +0200 Subject: [PATCH 3/4] Create GET_STARTED.md --- GET_STARTED.md | 70 ++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 70 insertions(+) create mode 100644 GET_STARTED.md diff --git a/GET_STARTED.md b/GET_STARTED.md new file mode 100644 index 0000000..4cabc4e --- /dev/null +++ b/GET_STARTED.md @@ -0,0 +1,70 @@ +

🚀 Getting Started

+ + +### Code Guidelines + +CuteApps currently don't have alot of guidelines, but it is best if you follow the few ones they have such as : + +- Clutter-free experience : This is self explanatory, avoid adding elements if un-needed, two example could be : + - flashing music icon : The music icon in the searchbar flashes red, indicating that it is clickable / has an action related to it + - the restart button, the seek to previous automatically becomes one 10 seconds in the song instead being a whole new button which brings us to the next guideline : + - Make things clear : If you are adding a feature, make sure it is clear of what it does, clear text/description, accurate icon + - Landscape : CuteApps MUST be fully compatible with landscape mode, if you are adding any screen, make sure it has a landscape variant, otherwise your PR will be ignored + - Creativity : This isn't mandatory, but if you are designing a screen or something else, be creative ! Try things no other apps has before, be unique ! Remember, failure is just a step closer to perfection ! + +### Prerequisites + +- Android Studio (latest version recommended) +- Java Development Kit (JDK) 11 or higher +- Git + +### Installation + +1. **Clone the repository:** + ```sh + git clone https://github.com/sosauce/CuteMusic.git + cd CuteMusic + ``` + +2. **Open the project in Android Studio:** + - Open Android Studio. + - Select `Open an existing project`. + - Navigate to the `CuteMusic` directory and select it. + +3. **Build the project:** + - Click on `Build` in the top menu. + - Select `Make Project` and ensure there are no errors. + +4. **Run the app:** + - Connect an Android device or use an emulator. + - Click on `Run` in the top menu. + - Select your device and click `OK`. + +### Contributing + +1. **Fork the repository:** + - Click the `Fork` button on the top right of the repository page. + +2. **Create a new branch:** + ```sh + git checkout -b feature/YourFeatureName + ``` + +3. **Make your changes:** + - Implement your feature or bug fix. + - Ensure your code follows the project's coding standards. +4. **Commit your changes:** + ```sh + git add . + git commit -m "Add feature: YourFeatureName" + ``` +5. **Push to your fork:** + ```sh + git push origin feature/YourFeatureName + ``` +6. **Create a Pull Request:** + - Go to the original repository. + - Click on `Pull Requests` and then `New Pull Request`. + - Select your branch and submit the pull request. + +Thank you to anyone taking their time to contribute and improve the app :heart:!!! From 43e863a4d1318b88d63b24eedf002b6ecf96c8c0 Mon Sep 17 00:00:00 2001 From: sosauce <98750531+sosauce@users.noreply.github.com> Date: Fri, 27 Sep 2024 17:05:37 +0200 Subject: [PATCH 4/4] Update README.md --- README.md | 60 +------------------------------------------------------ 1 file changed, 1 insertion(+), 59 deletions(-) diff --git a/README.md b/README.md index c5896a0..245fe94 100644 --- a/README.md +++ b/README.md @@ -59,63 +59,5 @@ You can find a copy of the GNU General Public License v3 [here](https://www.gnu. --- -

🚀 Getting Started

- -### Prerequisites - -- Android Studio (latest version recommended) -- Java Development Kit (JDK) 11 or higher -- Git - -### Installation - -1. **Clone the repository:** - ```sh - git clone https://github.com/sosauce/CuteMusic.git - cd CuteMusic - ``` - -2. **Open the project in Android Studio:** - - Open Android Studio. - - Select `Open an existing project`. - - Navigate to the `CuteMusic` directory and select it. - -3. **Build the project:** - - Click on `Build` in the top menu. - - Select `Make Project` and ensure there are no errors. - -4. **Run the app:** - - Connect an Android device or use an emulator. - - Click on `Run` in the top menu. - - Select your device and click `OK`. - -### Contributing - -1. **Fork the repository:** - - Click the `Fork` button on the top right of the repository page. - -2. **Create a new branch:** - ```sh - git checkout -b feature/YourFeatureName - ``` - -3. **Make your changes:** - - Implement your feature or bug fix. - - Ensure your code follows the project's coding standards. - -4. **Commit your changes:** - ```sh - git add . - git commit -m "Add feature: YourFeatureName" - ``` - -5. **Push to your fork:** - ```sh - git push origin feature/YourFeatureName - ``` - -6. **Create a Pull Request:** - - Go to the original repository. - - Click on `Pull Requests` and then `New Pull Request`. - - Select your branch and submit the pull request. +To get started with contributing, please check the [get started readme](https://github.com/sosauce/CuteMusic/blob/main/GET_STARTED.md)