about summary refs log tree commit diff stats
path: root/README
diff options
context:
space:
mode:
authorAndinus <andinus@nand.sh>2020-06-30 11:34:52 +0530
committerAndinus <andinus@nand.sh>2020-06-30 11:38:37 +0530
commite89d378596804d272a3e640a8bb1b95d783ff57b (patch)
treed97ca60d28fa02f455112c165f3c38f66a35f986 /README
parent16d9c289e912cb6eb49c86be012932193370723c (diff)
downloadcrux-e89d378596804d272a3e640a8bb1b95d783ff57b.tar.gz
Add dependencies section in README
Version numbers in cpanfile are the ones installed on my system, it'll
probably work with old versions too.
Diffstat (limited to 'README')
-rw-r--r--README20
1 files changed, 18 insertions, 2 deletions
diff --git a/README b/README
index 85c4186..54ca4ac 100644
--- a/README
+++ b/README
@@ -13,7 +13,8 @@ _________________
 .. 1.1 Options
 ..... 1.1.1 Crux
 ..... 1.1.2 Unsplash Source
-.. 1.2 Cross-platform compatibility
+.. 1.2 Dependencies
+.. 1.3 Cross-platform compatibility
 
 
 Crux is a wallpaper manager written in Perl, currently it supports
@@ -125,7 +126,22 @@ Crux someday.
   option can be passed to narrow the selection.
 
 
-1.2 Cross-platform compatibility
+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
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
   Crux should run on all supported platforms, there is OpenBSD specific