PixelDroid-App-Android/README.md

# PixelDroid
![Pixeldroid project logo](pixeldroid_logo.png)  
Free (as in freedom) Android client for Pixelfed, the federated image sharing platform.

[![Build Status](https://gitlab.shinice.net/pixeldroid/PixelDroid/badges/master/pipeline.svg)](https://gitlab.shinice.net/pixeldroid/PixelDroid/pipelines) [![Maintainability](https://api.codeclimate.com/v1/badges/a4f1747dc60b96eb74df/maintainability)](https://codeclimate.com/github/H-PixelDroid/PixelDroid/maintainability) [![Translation status](https://weblate.pixeldroid.org/widgets/pixeldroid/-/pixeldroid/svg-badge.svg)](https://weblate.pixeldroid.org/engage/pixeldroid/?utm_source=widget)  

<a href=https://apt.izzysoft.de/fdroid/index/apk/com.h.pixeldroid><img src="https://gitlab.com/IzzyOnDroid/repo/-/raw/master/assets/IzzyOnDroid.png" width="170"></a>

## Compiling the code yourself  
If you want to try out PixelDroid on your own device, you can try to compile the source code yourself. To do that you will need to install [Android Studio](https://developer.android.com/studio/).  
  
- Open the ___gradle___ project inside of Android Studio. Then you should plug your Android device into your computer (make sure that your device is in [developer mode](https://developer.android.com/studio/debug/dev-options)) and select ___share files___ on it. 

- You should see that Android studio has detected your device and its name should appear next to a small play button on the top right corner of Android Studio. If that is the case, then you can click said play button and, after Android studio will have built the project, you'll be able to use PixelDroid on your device!  
  
At this point PixelDroid will be installed on your phone, so it won't have to be plugged in anymore!
travis config, license and readme 2020-02-28 00:41:05 +01:00			`# PixelDroid`
Add translation badge, add logo to readme (#146) * Add translation badge, add logo to readme * add svg and png image 2020-05-03 14:32:35 +02:00			`![Pixeldroid project logo](pixeldroid_logo.png)`
Update README.md (#142) * Updated README.md 2020-05-01 16:59:52 +02:00			`Free (as in freedom) Android client for Pixelfed, the federated image sharing platform.`
badge 2020-02-28 00:56:08 +01:00
Improve CI 2020-06-24 15:34:14 +02:00			`[![Build Status](https://gitlab.shinice.net/pixeldroid/PixelDroid/badges/master/pipeline.svg)](https://gitlab.shinice.net/pixeldroid/PixelDroid/pipelines) [![Maintainability](https://api.codeclimate.com/v1/badges/a4f1747dc60b96eb74df/maintainability)](https://codeclimate.com/github/H-PixelDroid/PixelDroid/maintainability) [![Translation status](https://weblate.pixeldroid.org/widgets/pixeldroid/-/pixeldroid/svg-badge.svg)](https://weblate.pixeldroid.org/engage/pixeldroid/?utm_source=widget)`
Added compiling instructions to the readme (#174) * Added compiling instructions to the readme * Updated links * Fixed spelling mistake 2020-05-18 17:03:05 +02:00
Update README.md (#181) 2020-05-19 21:42:03 +02:00			`<a href=https://apt.izzysoft.de/fdroid/index/apk/com.h.pixeldroid><img src="https://gitlab.com/IzzyOnDroid/repo/-/raw/master/assets/IzzyOnDroid.png" width="170"></a>`

Added compiling instructions to the readme (#174) * Added compiling instructions to the readme * Updated links * Fixed spelling mistake 2020-05-18 17:03:05 +02:00			`## Compiling the code yourself`
			`If you want to try out PixelDroid on your own device, you can try to compile the source code yourself. To do that you will need to install [Android Studio](https://developer.android.com/studio/).`

			`- Open the ___gradle___ project inside of Android Studio. Then you should plug your Android device into your computer (make sure that your device is in [developer mode](https://developer.android.com/studio/debug/dev-options)) and select ___share files___ on it.`

			`- You should see that Android studio has detected your device and its name should appear next to a small play button on the top right corner of Android Studio. If that is the case, then you can click said play button and, after Android studio will have built the project, you'll be able to use PixelDroid on your device!`

			`At this point PixelDroid will be installed on your phone, so it won't have to be plugged in anymore!`