Skip to content

Commit

Permalink
README.md fix-3
Browse files Browse the repository at this point in the history
  • Loading branch information
DronDrin authored Dec 22, 2022
1 parent eb595f0 commit 4329152
Showing 1 changed file with 31 additions and 28 deletions.
59 changes: 31 additions & 28 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
<h1>Wallpaper searcher</h1>
<h3>Download wallpapers from wallpaper.cc<h3/>
<h1>Wallpaper searcher</h1>
<h3>Download wallpapers from wallpaper.cc</h3>

---

<h2>Dependencies:<h2/>
Program is made in java (actually in groovy, but it's compiled to .class or to .jar).
So you need java - openjre 17.
<h2>Dependencies:</h2>
Program is made in java (actually in groovy, but it's compiled to .class or to .jar).

So you need java - openjre 17.
How to install java?
For example:

Expand All @@ -17,53 +18,55 @@ For example:

---

<h2>How to download<h2/>
Go to https://github.com/DronDrin/WallpaperSearcher, select last release, and just download it.
<h2>How to download</h2>
Go to https://github.com/DronDrin/WallpaperSearcher, select last release, and just download it.

But if you want to make your own .jar file, you can clone repository https://github.com/DronDrin/WallpaperSearcher,
and run this command:
`gradle jar`
Of course, you must have gradle installed on your system.
So that's all! Your .jar is located at ROOT_DIRECTORY/build/libs/.
So that's all! Your .jar is located at ROOT_DIRECTORY/build/libs/.

---

<h2>How to run:<h2/>
<h2>How to run:</h2>
Program is .jar file.
So to start it you should enter this command:
`java -jar PATH_TO_JAR`
`java -jar PATH_TO_JAR`

---
<h2>Help:<h2/>
<h4>help<h4/>
<h2>Help:</h2>
<h4>help</h4>

this text is shown at first start of program
also run program with -h or --help parameter to see this text

<h4>parameters<h4/>
There are some parameters:
- '-q', '--query': :phrase that used to search wallpapers
- '-l', '--at-least': :minimum resolution of wallpaper
- '-r', '--ratio': :needed ratio of wallpaper
- '-p', '--path': :directory to save wallpapers in. Parent of this directory must exist
- '-n', '--number-of-packages': :Wallpapers is downloaded by batches (packages). Size of one package - 24.
<h4>parameters</h4>
There are some parameters:

* '-q', '--query': :phrase that used to search wallpapers
* '-l', '--at-least': :minimum resolution of wallpaper
* '-r', '--ratio': :needed ratio of wallpaper
* '-p', '--path': :directory to save wallpapers in. Parent of this directory must exist
* '-n', '--number-of-packages': :Wallpapers is downloaded by batches (packages). Size of one package - 24.
(Why? Because wallheaven.cc set this value as max query size)

<h4>modes<h4/>
<h4>modes</h4>
The program has two modes:
- first - interactive:
+ program asks you for each parameter
+ start program with '-i' parameter to use this mode
- second - parameterized:
+ use parameters from second paragraph, for example:
+ -q nature -l 1920x1080 -r 16x9 -p /home/alex/Wallpapers -n 5
* first - interactive:
* program asks you for each parameter
* start program with '-i' parameter to use this mode
* second - parameterized:
* use parameters from second paragraph, for example:
* -q nature -l 1920x1080 -r 16x9 -p /home/alex/Wallpapers -n 5

<h4>caching<h4/>
<h4>caching</h4>

agree, it would not be good if you would have to enter each parameter again every time when
you start the program. So each time when you enter any parameter, the program saves it.
Next time, you can skip this parameter (in all modes), and the program will use saved data.
But if you have never entered skipped parameter before, there will an error, so be careful with skipping.
<h4>example<h4/>
<h4>example</h4>
here is an example:

error ---- image 4djkeo has wrong resolution(1366x768)! It will not be downloaded
Expand Down

0 comments on commit 4329152

Please sign in to comment.