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.

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

Updated ReadMe #620

Open
wants to merge 1 commit into
base: dev
Choose a base branch
from
Open
Changes from all commits
Commits
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
56 changes: 52 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -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
<img src="https://gitlab.com/HoraApps/LeafPic/raw/abdf97052596380b8d4b838c6ab4a7c1bf854522/app/src/main/res/drawable/leaf_pic.png" align="left" width="200" hspace="10" vspace="10">
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.<br/>

### Download
<div style="display:flex;" >
<a href="https://f-droid.org/app/org.horaapps.leafpic">
<img src="https://f-droid.org/badge/get-it-on.png"
Expand All @@ -21,6 +21,19 @@ LeafPic is a fluid, material-designed alternative gallery, it also is ad-free an
</div>
</br></br>

# 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
<div style="display:flex;" >
<img src="screenshots/1.png" width="19%" >
Expand All @@ -32,11 +45,46 @@ LeafPic is a fluid, material-designed alternative gallery, it also is ad-free an
</div>

#### 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),
Expand Down