Updated README.md

2018-08-24 23:40:46 +01:00
parent f855b6eaea
commit 5653d717a1
3 changed files with 28 additions and 0 deletions
@@ -1 +1,29 @@
 # MarbleGenerator
+
+Generate a marble-like pattern to use in wallpapers.
+
+Usage :
+```
+java -jar MarbleGenerator.jar [output file name] [width] [height] [size]
+```
+
+Optional arguments :
+* 1 output file name :
+  * name of the output file (without extension)
+  * default is "wallpaper"
+* 2 width :
+  * width of image (square if no other arguments)
+  * default is your screen width
+* 3 height :
+  * height of image
+  * default is your screen height
+* 4 size :
+  * size of individual squares in the image
+  * default is random between 3 and 12
+
+It gives you something like this :
+
+
+![example](wallpaper.jpg)
+
+