aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorVee9ahd1 <[email protected]>2019-05-20 20:58:31 -0400
committerVee9ahd1 <[email protected]>2019-05-20 20:58:31 -0400
commit865f74669517cd878c072061601d4aba4015b34a (patch)
tree22d0b27f978664885632285dd79ca15d640e32d1 /README.md
parent0c66c424925d64e1b73198f1ace7676995f0e0e4 (diff)
added instructions to readme
Diffstat (limited to 'README.md')
-rw-r--r--README.md20
1 files 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 [email protected] --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).