Merge branch 'main' of https://github.com/sosauce/CuteMusic

GET_STARTED.md

@@ -0,0 +1,70 @@
+<h1>🚀 Getting Started</h1>
+
+
+### 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 <b>MUST</b> 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:!!!

README.md

@@ -31,7 +31,7 @@
 <h1>💬 Contact Me</h1>
 
 - Discord server: https://discord.gg/c6aCu4yjbu
-- Email = [email protected]
+- Email: [email protected]
 
 ---
 <h1>❤️ Support</h1>
@@ -57,3 +57,7 @@ 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/)</p>
 
+
+---
+To get started with contributing, please check the [get started readme](https://github.com/sosauce/CuteMusic/blob/main/GET_STARTED.md)
+