aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAndinus <andinus@nand.sh>2020-08-30 02:07:21 +0530
committerAndinus <andinus@nand.sh>2020-08-30 02:07:21 +0530
commitafffbbcb2a034bd1cad83b31f442cf77f17c2151 (patch)
tree083ab046b24e7776c9ae716823c87bb019c125bc
parent32ad6a07d9c5a863cb209a65f5ce0d5b21e58da4 (diff)
downloadpyxis-afffbbcb2a034bd1cad83b31f442cf77f17c2151.tar.gz
Add installation instructions in README, version option in helpHEADv0.1.0master
-rw-r--r--README21
-rwxr-xr-xpyxis.pl2
2 files changed, 23 insertions, 0 deletions
diff --git a/README b/README
index f1905f7..d7c8c01 100644
--- a/README
+++ b/README
@@ -14,6 +14,8 @@ Table of Contents
.. 2.1 Commands
.. 2.2 Examples
.. 2.3 Configuration
+3 Installation
+.. 3.1 Dependencies
Pyxis is a simple twtxt client.
@@ -115,3 +117,22 @@ hackers.
Add your feeds to `%feeds' hash like shown above. You can remove those
2 `use' lines but it's good if you keep them.
+
+
+3 Installation
+══════════════
+
+ Install these dependencies from CPAN. Then just clone the repository,
+ copy the config & run pyxis!
+
+
+3.1 Dependencies
+────────────────
+
+ • Getopt::Long is required only for options.
+ • [HTTP::Tiny] is only required if you use `fetch'.
+ • Path::Tiny can be replaced with perl core.
+ • Term::ANSIColor is just for good looks.
+ • Time::Moment can be replaced with DateTime or you can just `sort' it
+ directly. Sorting directly will mess up the order a bit but should
+ be okay for most cases.
diff --git a/pyxis.pl b/pyxis.pl
index 83c35ef..61e3035 100755
--- a/pyxis.pl
+++ b/pyxis.pl
@@ -29,6 +29,8 @@ Commands:
Options:
--verbose
Verbose operation mode.
+ --version
+ Print Pyxis version.
--help
Print this help.";
exit 0;