summary refs log tree commit diff stats
path: root/README.org
diff options
context:
space:
mode:
authorAndinus <andinus@nand.sh>2020-11-24 13:48:59 +0530
committerAndinus <andinus@nand.sh>2020-11-24 13:48:59 +0530
commit514a17069dbb06ffd272a2d57935fa8e8681969e (patch)
tree959bb2b76bbd45235f5b1c77cda48c07228278a0 /README.org
parentfd9bde6f64c8d792c555678dc1dee8ae3665156e (diff)
downloaddraco-514a17069dbb06ffd272a2d57935fa8e8681969e.tar.gz
Update instructions in README, add comments in draco.pl, fix bug v0.2.1
$comment in print_comment_chain() was changed to $comment_data to
prevent confusion in future.

We have to check if url has "/" at the end because if it does have it
then previously we were appending "$comment_data->{id}.json" to it
which makes the url look like:

      http://<reddit>/<post_id>//<comment_id>.json

And reddit doesn't like that, reddit wants it to be:

      http://<reddit>/<post_id>/<comment_id>.json

Notice the double '/' in previous link.
Diffstat (limited to 'README.org')
-rw-r--r--README.org33
1 files changed, 26 insertions, 7 deletions
diff --git a/README.org b/README.org
index ab1273f..2ad7f8c 100644
--- a/README.org
+++ b/README.org
@@ -20,15 +20,19 @@ This was recorded with =asciinema(1)=.
 [[https://asciinema.org/a/373860][https://asciinema.org/a/373860.png]]
 
 + Draco v0.1.2: https://asciinema.org/a/373860
-  - alt-link: https://andinus.nand.sh/static/draco/v0.1.2.cast
 + Draco 2020-11-19: https://asciinema.org/a/373851
-  - alt-link: https://andinus.nand.sh/static/draco/2020-11-19.cast
+
++ alt-links (download)
+  - v0.1.2: https://andinus.nand.sh/static/draco/v0.1.2.cast
+  - 2020-11-19: https://andinus.nand.sh/static/draco/2020-11-19.cast
 * Installation
 Follow these instructions to get draco & then install the dependencies,
 they're listed below. All dependencies are in Debian & Fedora
 repositories.
 
 Check the /News/ section before updating or downloading latest release.
+** Release
+Release archives are generated by cgit/GitHub.
 
 1. Download the release:
    - https://git.tilde.institute/andinus/draco
@@ -37,17 +41,32 @@ Check the /News/ section before updating or downloading latest release.
 3. =cd= into the directory.
 4. Run =make install= as root.
 5. Install dependencies.
+** From Source
+All commits will be signed by my [[https://andinus.nand.sh/static/D9AE4AEEE1F1B3598E81D9DFB67D55D482A799FD.asc][PGP Key]].
+
+#+BEGIN_SRC sh
+# Clone the project.
+git clone https://git.tilde.institute/andinus/draco
+cd draco
+
+# Install draco. Use `sudo' if `doas' is not present.
+doas make install
+
+# Install dependencies. See the section below.
+#+END_SRC
 * Dependencies
+** OpenBSD
 #+BEGIN_SRC sh
-# Install dependencies. (OpenBSD)
 doas pkg_add p5-Unicode-LineBreak p5-JSON-MaybeXS
 cpan install HTTP::Tiny
-
-# Install dependencies. (Debian - apt based)
+#+END_SRC
+** Debian (apt)
+#+BEGIN_SRC sh
 sudo apt install libunicode-linebreak-perl libjson-maybexs-perl \
      libhttp-tiny-perl
-
-# Install dependencies. (Fedora - dnf based)
+#+END_SRC
+** Fedora (dnf)
+#+BEGIN_SRC sh
 sudo dnf install perl-JSON-MaybeXS perl-HTTP-Tiny perl-Unicode-LineBreak
 #+END_SRC
 * News