README (at least)

This commit is contained in:
klemek
2020-04-26 22:45:23 +02:00
parent 66efef564f
commit 52dc013ef6
3 changed files with 51 additions and 3 deletions
+38 -1
View File
@@ -1,3 +1,40 @@
# meme-otron # meme-otron
### WIP *When making a meme need to be instantaneous*
This is a Python module (and a discord bot) to make memes from templates, like this:
![](main.jpg)
> ```bash
> python3 -m meme_otron brain3 \
> "Making memes using an image editor" \
> "Making memes using a Python script" \
> "Making memes using a Discord bot" > main.jpg
> ```
## Installation
```bash
git clone https://github.com/Klemek/meme-otron
cd meme-otron
pip install -r requirements.txt
```
You're good to go
## Quick start
```bash
python -m meme_otron [meme_id] "text 1" "text 2" ... > output.jpg
```
## More info
The full documentation can be found [here](./tree/master/docs/README.md).
It includes:
* Arguments syntax
* Discord help
* CLI help
* Full list of templates with images
+13 -2
View File
@@ -7,12 +7,12 @@ You can generate memes by using the following arguments:
``` ```
Depending of the number of `"text"` arguments, several behavior occurs: Depending of the number of `"text"` arguments, several behavior occurs:
* **None**: you get the template that gives you locations of texts. (see below) * **None**: you get the template that gives you the locations of texts. (see below)
* **Less than the template's**: the remaining texts are blank on the output * **Less than the template's**: the remaining texts are blank on the output
* **More than the template's**: the extra arguments are ignored * **More than the template's**: the extra arguments are ignored
> Notes > Notes
> * You don't have to use all texts shown on templates > * You don't have to use all texts shown on the templates
> * You can use an empty text argument ( `""` ) to skip a text and keep it blank > * You can use an empty text argument ( `""` ) to skip a text and keep it blank
## Discord features ## Discord features
@@ -25,7 +25,18 @@ Tag the bot and use the above syntax to get started. In addition, you can use th
Enjoy the full experience of this bot by using direct messages to keep your server free of spam. Enjoy the full experience of this bot by using direct messages to keep your server free of spam.
## CLI features
In this project directory, you can simply call:
```
python -m meme_otron [meme id] "text1" "text2" ... > output.jpg
```
Without pipe redirection with `-c [output]`:
```
python -m meme_otron -c output.png [meme id] "text1" "text2" ...
```
> Note: with `-c`, you are free to choose the output format
## List of templates ## List of templates
BIN
View File
Binary file not shown.

After

Width:  |  Height:  |  Size: 40 KiB