summary refs log tree commit diff stats
path: root/README.org
diff options
context:
space:
mode:
Diffstat (limited to 'README.org')
-rw-r--r--README.org23
1 files changed, 21 insertions, 2 deletions
diff --git a/README.org b/README.org
index e67f818..81f9c93 100644
--- a/README.org
+++ b/README.org
@@ -15,12 +15,31 @@ the reddit API.
 *Tested on*:
 - OpenBSD 6.8 (Perl v5.30.3)
 
+* Why?
+I reference things from the web in my Journal & don't want those links
+to break so I save them locally. Previously I used to manually archive
+the whole thread, this automates it.
 * Installation
 #+BEGIN_SRC sh
 # Clone the project.
 git clone https://git.tilde.institute/andinus/draco && \
     cd draco
 
-# Install.
-sudo make install
+# Install dependencies. (OpenBSD)
+doas pkg_add p5-Text-Wrapper p5-JSON-MaybeXS
+cpan install HTTP::Tiny
+
+# Install. (Use sudo if doas is not present)
+doas make install
 #+END_SRC
+
+* Dependencies
+** Text::Wrapper
+This is used to wrap the text at 72 characters. Draco can work without
+this module.
+** JSON::MaybeXS
+This module is required for Draco to work, it can be replaced with any
+other module that parses JSON & produces same data structure.
+** HTTP::Tiny
+Draco can work without this module if you can get the file some other
+way.