diff options
| -rw-r--r-- | README | 71 |
1 files changed, 40 insertions, 31 deletions
diff --git a/README b/README index 54ca4ac..9d41258 100644 --- a/README +++ b/README @@ -10,10 +10,10 @@ Table of Contents _________________ 1 Documentation -.. 1.1 Options -..... 1.1.1 Crux -..... 1.1.2 Unsplash Source -.. 1.2 Dependencies +.. 1.1 Dependencies +.. 1.2 Options +..... 1.2.1 Crux +..... 1.2.2 Unsplash Source .. 1.3 Cross-platform compatibility @@ -35,13 +35,37 @@ Crux someday. 1 Documentation =============== -1.1 Options +1.1 Dependencies +~~~~~~~~~~~~~~~~ + + `feh' is required to set the background. Other DE/WMs & macOS can be + easily supported, if you want it then look at [Cetus]'s source or ping + me, I'll add it. Basically you just have to use `HTTP::Tiny' or + something to download the image & set it as background with DE/WM + specific tools. + + The version numbers mentioned in cpanfile is not the minimum required + to run Crux, you can try lowering them. Might also make this work + without some dependencies, look at `lib/' and see what dependencies + you can remove. + + For example, you can probably remove Carp & replace it with `die', not + the same thing but it should work. + + *Note*: Do this only if you can't install those dependencies for some + reason. + + +[Cetus] https://andinus.nand.sh/cetus/ + + +1.2 Options ~~~~~~~~~~~ -1.1.1 Crux +1.2.1 Crux ---------- -* 1.1.1.1 debug +* 1.2.1.1 debug This will print additional information that'll help you to debug the code. You might see multiple Unveil warnings on non-OpenBSD systems, @@ -50,13 +74,13 @@ Crux someday. $response received from the api will also be printed. -* 1.1.1.2 help +* 1.2.1.2 help Prints quick help information listing all the options & a small description. -1.1.2 Unsplash Source +1.2.2 Unsplash Source --------------------- Some options cannot be mixed, if you mix them then expect unexpected @@ -79,14 +103,14 @@ Crux someday. [Unsplash Source] https://source.unsplash.com -* 1.1.2.1 resolution +* 1.2.2.1 resolution Default is "1920x1080", it doesn't check the value passed so make sure you pass the correct value. This can be passed with any option, it will be ignored if not applicable. -* 1.1.2.2 search +* 1.2.2.2 search Search accepts multiple space seperated values. It's passed directly to the api. @@ -98,49 +122,34 @@ Crux someday. equivalent to `--search rocky mountain'. -* 1.1.2.3 featured +* 1.2.2.3 featured Only Unsplash curated images are returned if you pass `featured', this can be passed along with `search'. -* 1.1.2.4 user +* 1.2.2.4 user This will return a random photo from given user. -* 1.1.2.5 userlikes +* 1.2.2.5 userlikes Only returns random photo from user's likes, this is a boolean & can be passed with `user' option. -* 1.1.2.6 collection +* 1.2.2.6 collection Returns photos from a collection. -* 1.1.2.7 daily, weekly +* 1.2.2.7 daily, weekly This will return a set random daily or weekly image. `user' & `search' option can be passed to narrow the selection. -1.2 Dependencies -~~~~~~~~~~~~~~~~ - - The version numbers mentioned in cpanfile is not the minimum required - to run Crux, you can try lowering them. Might also make this work - without some dependencies, look at `lib/' and see what dependencies - you can remove. - - For example, you can probably remove Carp & replace it with `die', not - the same thing but it should work. - - *Note*: Do this only if you can't install those dependencies for some - reason. - - 1.3 Cross-platform compatibility ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |