diff --git a/README.md b/README.md index 90a8ba78..ad1f240c 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,13 @@ -## This project is no longer maintained - [![Crowdin](https://d322cqt584bo4o.cloudfront.net/leafpic/localized.svg)](https://crowdin.com/project/leafpic) [![Donate](https://img.shields.io/badge/donate-paypal-blue.svg)](https://www.paypal.me/HoraApps) - + +**PSA**: We are moving on [gitlab](https://gitlab.com/HoraApps/LeafPic), the repo on Github will remain as a mirror. Don't submit PR on gihub. # LeafPic LeafPic is a fluid, material-designed alternative gallery, it also is ad-free and open source under GPLv3 license. It doesn't miss any of the main features of a stock gallery, and we also have plans to add more useful features.
+### Download


+# Table of Contents +- [LeafPic](#leafpic) +- [Download](#download) +- [Screenshots](#screenshots) +- [Contributing](#contributing) + - [Prerequisites](#prerequisites) + - [Getting Started](#getting-started) +- [Building and Running](#building-and-running) + - [Testing](#testing) + - [Issues](#issues) + - [Translations](#translations) +- [Licensing](#licensing) + ## Screenshots
@@ -32,11 +45,46 @@ LeafPic is a fluid, material-designed alternative gallery, it also is ad-free an
#### Contributing -## This project is no longer maintained + +### Prerequisites + +- Android Studio +- Git +- JDK (Java Development Kit) + +### Getting Started + +1. **Fork and clone the repository**: + + Fork the project on GitLab and clone your fork locally. + + git clone https://gitlab.com/YOUR_USERNAME/LeafPic.git + + cd LeafPic + +2. **Open the project in Android Studio**: + + Start Android Studio and select "Open an Existing Project", then navigate to the folder where you cloned LeafPic. + +3. **Install the required SDKs**: + + Android Studio will prompt you to install the Android SDK and other necessary tools if you have not already done so. + + +## Building and Running + +1. **Select a build variant**: In Android Studio, you can select which version of the app you want to build (debug/release) from the Build Variants panel. + +2. **Run the app**: Connect an Android device to your computer or use the AVD (Android Virtual Device) Manager to create a new emulator. Click the 'Run' button in Android Studio to build and run the app on your device/emulator. + +###### Testing +Do you want to be a tester? Join our Telegram group! Send a message to [@dnldsht](https://t.me/dnldsht) or [@CalvinNoronha](https://t.me/CalvinNoronha) we will add you. +We will release apks to test features or to check if bugs have been fixed. ###### Code If you are a developer and you wish to contribute to the app please fork the project and submit a pull request on the [dev branch](https://gitlab.com/HoraApps/LeafPic/tree/dev). +If you want, you can join us on Telegram - send us a message we will add you! ###### Issues You can trace the status of known issues [here](https://gitlab.com/HoraApps/LeafPic/issues),