From 865f74669517cd878c072061601d4aba4015b34a Mon Sep 17 00:00:00 2001 From: Vee9ahd1 Date: Mon, 20 May 2019 20:58:31 -0400 Subject: added instructions to readme --- README.md | 20 ++++++++++++++++++-- 1 file changed, 18 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 4ad3f8b..8b582f4 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,19 @@ -# GANtools +#GANtools -Python-based cli tools for generating images using bigGAN. \ No newline at end of file +Python-based cli tools for generating images using bigGAN. + +##Instructions +1. Install Python 3 (note for macOS users: if you are going to use brew to install python make sure you replace `python` with `python3` and `pip` with `pip3` in all of the following steps). +2. Install gantools +``` +pip install git+https://gitlab.com/Vee9ahd1/gantools +``` +3. Read the help dialog +``` +gantools -h +``` +4. Example usage: +``` +gantools --username username@email.com --password mypassword123 --nframes 20 --keys 7968340a72eabab735d04dba 0416461072e5e22fd6d1637c c37d216dfd865aa7397db242 +``` +where the hexidecimal strings after `--keys` are the IDs found in an image's ganbreeder URL (e.g. https://ganbreeder.app/i?k=c37d216dfd865aa7397db242 has key: c37d216dfd865aa7397db242). -- cgit v1.2.1