diff options
author | Andinus <andinus@nand.sh> | 2020-11-19 11:42:42 +0530 |
---|---|---|
committer | Andinus <andinus@nand.sh> | 2020-11-19 11:42:42 +0530 |
commit | 5a117add1c0a64c4f0141ef0897361774a849246 (patch) | |
tree | d7bb4b4d45efcd6470dd9533b21de2cb855f905a /README.org | |
parent | 20dd49106d6bc1dc847ff93ce48d0dec285f45e3 (diff) | |
download | draco-5a117add1c0a64c4f0141ef0897361774a849246.tar.gz |
Add notes to README & manual regarding new changes
Diffstat (limited to 'README.org')
-rw-r--r-- | README.org | 23 |
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. |