Skip to content

Commit

Permalink
Update Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
@gsantner
gsantner committed Aug 24, 2017
1 parent c32bc45 commit c659c77
Show file tree
Hide file tree
Showing 2 changed files with 53 additions and 38 deletions.
3 changes: 3 additions & 0 deletions CHANGELOG.md
View file
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
### v1.2.4
- Updated: Readme

### v1.2.3
- Added: Option to change app language
- Added: Brazilian localization
Expand Down
88 changes: 50 additions & 38 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,18 +1,27 @@
# ![App icon](https://raw.githubusercontent.com/gsantner/memetastic/master/app/src/main/res/drawable-mdpi/ic_launcher.png "App Icon") MemeTastic

<span class="badge-bitcoin"><a href="https://gsantner.github.io/#donate" title="Donate once-off to this project using Bitcoin"><img src="https://img.shields.io/badge/bitcoin-donate-yellow.svg" alt="Bitcoin donate button" /></a></span> [![CircleCI](https://circleci.com/gh/gsantner/memetastic.svg?style=shield)](https://circleci.com/gh/gsantner/memetastic) [![Translate - with Stringlate](https://img.shields.io/badge/stringlate-translate-green.svg)](https://lonamiwebs.github.io/stringlate/translate?git=https%3A%2F%2Fgithub.com%2Fgsantner%2Fmemetastic.git&name=MemeTastic&web=https%3A%2F%2Fgithub.com%2Fgsantner%2FMemeTastic)
[![GitHub release](https://img.shields.io/github/tag/gsantner/memetastic.svg)](https://github.com/gsantner/memetastic/releases)
[![Donate](https://img.shields.io/badge/donate-bitcoin-orange.svg)](https://gsantner.github.io/#donate)
[![CircleCI](https://circleci.com/gh/gsantner/memetastic.svg?style=shield)](https://circleci.com/gh/gsantner/memetastic)
[![Translate - with Stringlate](https://img.shields.io/badge/stringlate-translate-green.svg)](https://lonamiwebs.github.io/stringlate/translate?git=https%3A%2F%2Fgithub.com%2Fgsantner%2Fmemetastic.git&name=MemeTastic&web=https%3A%2F%2Fgithub.com%2Fgsantner%2Fmemetastic)
[![Chat - Matrix](https://img.shields.io/badge/chat-on%20matrix-blue.svg)](https://matrix.to/#/#memetastic:matrix.org) [![Chat - FreeNode IRC](https://img.shields.io/badge/chat-on%20irc-blue.svg)](https://kiwiirc.com/client/irc.freenode.net/?nick=memetastic-anon|?#memetastic)

[![F-Droid](https://f-droid.org/wiki/images/0/06/F-Droid-button_get-it-on.png)](https://f-droid.org/repository/browse/?fdid=io.github.gsantner.memetastic)
# MemeTastic
<img src="/app/src/main/ic_launcher-web.png" align="left" width="100" hspace="10" vspace="10">
<b>Simple Meme Creator</b> which includes most common templates. Completly ad-free,
works offline and adds no watermarks. Memes can be created from templates included in the app, from pictures shared
into the app and pictures from gallery & camera.

<div style="display:flex;" >
<a href="https://f-droid.org/repository/browse/?fdid=io.github.gsantner.memetastic">
<img src="https://f-droid.org/badge/get-it-on.png" alt="Get it on F-Droid" height="80">
</a>
<a href="https://play.google.com/store/apps/details?id=io.github.gsantner.memetastic">
<img alt="Get it on Google Play" height="80" src="https://play.google.com/intl/en_us/badges/images/generic/en_badge_web_generic.png" />
</a>
</div></br>

**MemeTastic - Meme Creator for Android**
Available for devices running Ice Cream Sandwich (4.0.0 / API14) and above
Developed and maintained by [Gregor Santner](<https://gsantner.github.io>), 2016-
License: **GPLv3**

## Description
* Ad-Free and no watermarks
* Ad-Free and no watermarks
* Allows you to create memes from
* Templates included in the app
* Camera pictures
Expand All @@ -30,20 +39,17 @@ License: **GPLv3**
* Change amount of displayed pictures per row
* Works completly offline, no connection required

## Download
* [F-Droid](https://f-droid.org/repository/browse/?fdid=io.github.gsantner.memetastic)
### Privacy<a name="privacy"></a>
The app doesn't use your int ernet connection, it's working completly offline. It doesn't share any personal information with other apps or any web-server.
Custom images can be added via camera and gallery. If the user decides to save a meme image it will be stored locally in the device public pictures folder.

## Contributions
The project is always open for contributions and accepts pull requests.
The project is always open for co ntributions and accepts pull requests.
The project uses [AOSP Java Code Style](https://source.android.com/source/code-style#follow-field-naming-conventions), with one exception: private members are `_camelCase` instead of `mBigCamel`. You may use Android Studios _auto reformat feature_ before sending a PR.

Join our IRC or Matrix channel (bridged) and say hello! Don't be afraid to start talking. [![Chat - Matrix](https://img.shields.io/badge/chat-on%20matrix-blue.svg)](https://matrix.to/#/#memetastic:matrix.org) [![Chat - FreeNode IRC](https://img.shields.io/badge/chat-on%20irc-blue.svg)](https://kiwiirc.com/client/irc.freenode.net/?nick=memetastic-anon|?#memetastic)




Translations can be contributed on GitHub or via [E-Mail](https://gsantner.github.io/#contact). You can use Stringlate ([![Translate - with Stringlate](https://img.shields.io/badge/stringlate-translate-green.svg)](https://lonamiwebs.github.io/stringlate/translate?git=https%3A%2F%2Fgithub.com%2Fgsantner%2Fmemetastic.git&name=MemeTastic&web=https%3A%2F%2Fgithub.com%2Fgsantner%2FMemeTastic)) to translate the project directly on your Android phone. It allows you to export as E-Mail attachement and to post on GitHub.
Translations can be contributed on GitHub or via [E-Mail](https://gsantner.github.io/#contact). You can use Stringlate ([![Translate - with Stringlate](https://img.shields.io/badge/stringlate-translate-green.svg)](https://lonamiwebs.github.io/stringlate/translate?git=https%3A%2F%2Fgithub.com%2Fgsantner%2Fmemetastic.git&name=MemeTastic&web=https%3A%2F%2Fgithub.com%2Fgsantner%2Fmemetastic)) to translate the project directly on your Android phone. It allows you to export as E-Mail attachement and to post on GitHub.

Join our IRC or Matrix channel (bridged) and say hello! Don't be afraid to start talking. [![Chat - Matrix](https://img.shields.io/badge/chat-on%20matrix-blue.svg)](https://matrix.to/#/#memetastic:matrix.org) [![Chat - FreeNode IRC](https://img.shields.io/badge/chat-on%20irc-blue.svg)](https://kiwiirc.com/client/irc.freenode.net/?nick=memetastic-anon|?#memetastic)

For inclusion of new fonts or memes visit [issue #1](https://github.com/gsantner/memetastic/issues/1).
Please only post stuff you own, is allowed to redistribute, or to be considered fair use.
Expand All @@ -54,8 +60,17 @@ You can maybe find something suitable here:
* Fonts: [1001fonts](http://www.1001fonts.com) | [Font Squirell](https://www.fontsquirrel.com/fonts/list/find_fonts?filter%5Blicense%5D%5B0%5D=app&filter%5Blicense%5D%5B1%5D=open&sort=hot) | [fontspace](http://www.fontspace.com/) | [Google Fonts](https://fonts.google.com) | [Identify font](https://www.fontsquirrel.com/matcherator)
* Memes: [knowyourmeme.com](http://knowyourmeme.com) | [/r/MemeTemplatesOfficial](https://www.reddit.com/r/MemeTemplatesOfficial) | [memes.at](http://www.memes.at/)


If you like my work on <b>MemeTastic</b> and many other Open Source projects, consider a small donation to my bitcoin address:
<a href="https://gsantner.github.io/#donate">1B9ZyYdQoY9BxMe9dRUEKaZbJWsbQqfXU5</a>


#### Resources
* Project: [Changelog](/CHANGELOG.md) | [Issues level/beginner](https://github.com/gsantner/memetastic/issues?q=is%3Aissue+is%3Aopen+label%3Alevel%2Fbeginner) | [License](/LICENSE.txt) | [CoC](/CODE_OF_CONDUCT.md)
* App on F-Droid: [Metadata](https://gitlab.com/fdroid/fdroiddata/blob/master/metadata/io.github.gsantner.memetastic.txt) | [Page](https://f-droid.org/packages/io.github.gsantner.memetastic/) | [Wiki](https://f-droid.org/wiki/page/io.github.gsantner.memetastic) | [Build log](https://f-droid.org/wiki/page/io.github.gsantner.memetastic/lastbuild)

## Licensing
Copyright (C) 2016-2017 MemeTastic contributors \<https://github.com/gsantner/memetastic\>
Co pyright (C) 2016-2017 MemeTastic contributors <https://github.com/gsantner/memetastic>
The app is licensed GPL v3. Localization files (strings\*.xml) are licensed CC0 1.0.
For more licensing informations, see [`3rd party licenses`](/app/src/main/res/raw/licenses_3rd_party.md).
We consider fair use of the included meme templates. (*All trademarks and copyrights belong to their respective owners and are used here under the terms of Fair Use and the Digital Millennium Copyrights Act (DMCA).*)
Expand All @@ -70,24 +85,21 @@ If you publish an app based on MemeTastic you MUST
* Show that the app is `based on MemeTastic by MemeTastic contributors`. Include a link to https://github.com/gsantner/memetastic
* Show that the app is not MemeTastic but an modified/custom version, and the original app contributors are not responsible for modified versions or endorse your product

## Privacy
The app doesn't use your internet connection, it's working completly offline. It doesn't share any personal information with other apps or any web-server.
Custom images can be added via camera and gallery. If the user decides to save a meme image it will be stored locally in the device public pictures folder.

## Screenshots
<table>
<tr>
<td> <img src="https://cloud.githubusercontent.com/assets/6735650/23828355/81b1f37e-06cf-11e7-8aec-537fb376ae80.png" /> </td>
<td> <img src="https://user-images.githubusercontent.com/6735650/28480696-31d4e3e8-6e62-11e7-9512-5acfa05699b2.png" /> </td>
</tr><tr>
<td> <img src="https://cloud.githubusercontent.com/assets/6735650/23828354/81ae7cb2-06cf-11e7-8eee-66e6af799c1c.png" /> </td>
<td> <img src="https://user-images.githubusercontent.com/6735650/28480457-13f96034-6e61-11e7-9382-81f8fbda963e.png" /> </td>
</tr><tr>
<td> <img src="https://user-images.githubusercontent.com/6735650/28741628-d7ec701c-741a-11e7-91df-cb3e7df8ecb6.png" /> </td>
<td> <img src="https://cloud.githubusercontent.com/assets/6735650/23828356/81b5cf3a-06cf-11e7-8796-8b903b5c8e43.png" /> </td>
</tr><tr>
<td> <img src="https://user-images.githubusercontent.com/6735650/28741629-d810a9e6-741a-11e7-8a68-5e9e9992f67d.png" /> </td>
<td> <img src="https://user-images.githubusercontent.com/6735650/28741630-d810ff68-741a-11e7-927f-b5556974cdbc.png" /> </td>
</tr>
</table>

<div style="display:flex;" >
<img src="https://raw.githubusercontent.com/gsantner/memetastic-metadata-latest/master/en-US/phoneScreenshots/01.png" width="19%" >
<img src="https://raw.githubusercontent.com/gsantner/memetastic-metadata-latest/master/en-US/phoneScreenshots/02.png" width="19%" style="margin-left:10px;" >
<img src="https://raw.githubusercontent.com/gsantner/memetastic-metadata-latest/master/en-US/phoneScreenshots/03.png" width="19%" style="margin-left:10px;" >
<img src="https://raw.githubusercontent.com/gsantner/memetastic-metadata-latest/master/en-US/phoneScreenshots/04.png" width="19%" style="margin-left:10px;" >
<img src="https://raw.githubusercontent.com/gsantner/memetastic-metadata-latest/master/en-US/phoneScreenshots/05.png" width="19%" style="margin-left:10px;" >
</div>

<div style="display:flex;" >
<img src="https://raw.githubusercontent.com/gsantner/memetastic-metadata-latest/master/en-US/phoneScreenshots/06.png" width="19%" >
<img src="https://raw.githubusercontent.com/gsantner/memetastic-metadata-latest/master/en-US/phoneScreenshots/07.png" width="19%" style="margin-left:10px;" >
<img src="https://raw.githubusercontent.com/gsantner/memetastic-metadata-latest/master/en-US/phoneScreenshots/08.png" width="19%" style="margin-left:10px;" >
<img src="https://raw.githubusercontent.com/gsantner/memetastic-metadata-latest/master/en-US/phoneScreenshots/09.png" width="19%" style="margin-left:10px;" >
</div>

### Notice

0 comments on commit c659c77

Please sign in to comment.