Skip to content

Commit 022e7cb

Browse files
committed
Re-format README, Add dependency instructions, Update NEWS
1 parent ea84c0b commit 022e7cb

File tree

1 file changed

+58
-16
lines changed

1 file changed

+58
-16
lines changed

README.org

Lines changed: 58 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,23 @@
1-
#+SETUPFILE: ~/.emacs.d/org-templates/projects.org
2-
#+EXPORT_FILE_NAME: index
3-
#+OPTIONS: toc:1
4-
#+TITLE: Draco
1+
#+title: Draco
2+
#+setupfile: ~/.emacs.d/org-templates/projects.org
3+
#+export_file_name: index
54

65
Draco is a script to convert reddit thread to Org document. It accepts a
76
url & prints the Org document to STDOUT. It'll also print comments along
87
with their replies.
98

10-
| Project Home | [[https://andinus.nand.sh/draco/][Draco]] |
11-
| Source Code | [[https://git.tilde.institute/andinus/draco/][Andinus / Draco]] |
9+
| Project Home | [[https://andinus.nand.sh/projects/draco/][Draco]] |
10+
| Source Code | [[https://git.unfla.me/draco/][Andinus / Draco]] |
1211
| GitHub (Mirror) | [[https://github.com/andinus/draco/][Draco - GitHub]] |
1312

1413
* Why?
14+
1515
I reference things from the web in my Journal & don't want those links
1616
to break so I save them locally. Previously I used to manually archive
1717
the whole thread, this automates it.
18+
1819
* Demo
20+
1921
This was recorded with =asciinema(1)=.
2022

2123
[[https://asciinema.org/a/373860][https://asciinema.org/a/373860.png]]
@@ -24,13 +26,17 @@ This was recorded with =asciinema(1)=.
2426
+ Draco v0.1.2: https://asciinema.org/a/373860
2527
+ Draco 2020-11-19: https://asciinema.org/a/373851
2628
+ alt-link (download): https://andinus.nand.sh/static/draco/
29+
2730
* Installation
31+
2832
Follow these instructions to get draco & then install the dependencies,
2933
they're listed below. All dependencies are in Debian & Fedora
3034
repositories.
3135

3236
Check the /News/ section before updating or downloading latest release.
37+
3338
** Release
39+
3440
Release archives are generated by cgit/GitHub.
3541

3642
1. Download the release:
@@ -40,10 +46,12 @@ Release archives are generated by cgit/GitHub.
4046
3. =cd= into the directory.
4147
4. Run =make install= as root.
4248
5. Install dependencies.
49+
4350
** From Source
51+
4452
All commits will be signed by my [[https://andinus.nand.sh/static/D9AE4AEEE1F1B3598E81D9DFB67D55D482A799FD.asc][PGP Key]].
4553

46-
#+BEGIN_SRC sh
54+
#+begin_src sh
4755
# Clone the project.
4856
git clone https://git.tilde.institute/andinus/draco
4957
cd draco
@@ -52,35 +60,63 @@ cd draco
5260
doas make install
5361

5462
# Install dependencies. See the section below.
55-
#+END_SRC
63+
#+end_src
64+
5665
* Dependencies
66+
5767
** OpenBSD
58-
#+BEGIN_SRC sh
68+
69+
#+begin_src sh
5970
doas pkg_add p5-Unicode-LineBreak p5-JSON-MaybeXS p5-IO-Socket-SSL
6071
cpan install HTTP::Tiny
61-
#+END_SRC
72+
#+end_src
73+
6274
** Debian (apt)
63-
#+BEGIN_SRC sh
75+
76+
#+begin_src sh
6477
sudo apt install libunicode-linebreak-perl libjson-maybexs-perl \
65-
libhttp-tiny-perl
66-
#+END_SRC
78+
libhttp-tiny-perl libio-socket-ssl-perl
79+
#+end_src
80+
6781
** Fedora (dnf)
68-
#+BEGIN_SRC sh
69-
sudo dnf install perl-JSON-MaybeXS perl-HTTP-Tiny perl-Unicode-LineBreak
70-
#+END_SRC
82+
83+
#+begin_src sh
84+
sudo dnf install perl-JSON-MaybeXS perl-HTTP-Tiny perl-Unicode-LineBreak \
85+
perl-IO-Socket-SSL
86+
#+end_src
87+
7188
* News
89+
90+
** v0.3.3 - 2022-08-09
91+
92+
+ Add IO::Socket::SSL dependency.
93+
Required for HTTPs support.
94+
95+
+ Print response 'contents' on errors.
96+
From https://metacpan.org/pod/HTTP::Tiny,
97+
#+begin_quote
98+
Errors during request execution will result in a pseudo-HTTP status
99+
code of 599 and a reason of "Internal Exception". The content field in
100+
the response will contain the text of the error.
101+
#+end_quote
102+
72103
** v0.3.2 - 2020-11-26
104+
73105
+ Add =author_flair_text= to properties section of each comment.
74106
+ Keep each dot in a single line.
75107
This feature was added in v0.3.0 but each dot was printed in a new
76108
line. For huge posts this would be annoying so now dots are printed in
77109
a single line.
110+
78111
** v0.3.1 - 2020-11-25
112+
79113
Minor improvement.
80114

81115
+ Put author name in code block if it begins & ends with "=_=".
82116
Org underlines headings that begin & end with "=_=".
117+
83118
** v0.3.0 - 2020-11-24
119+
84120
This version adds code to fetch all the comments in a thread. Now users
85121
can archive the whole thread.
86122

@@ -92,16 +128,22 @@ for small changes from the git history.
92128
+ Add debug message for HTTP calls.
93129
It'll print a "." for every HTTP call. Users will be able to tell when
94130
the script is making HTTP calls.
131+
95132
** v0.2.2 - 2020-11-24
133+
96134
This version is mostly structural changes, it'll now be easier to add
97135
code to fetch comments hidden behind "continue this thread".
98136

99137
+ Add more debug information.
138+
100139
** v0.2.1 - 2020-11-24
140+
101141
+ Previously fetching comments hidden under "load more comments" would
102142
fail if the url passed by user ends in "/". This has been fixed in
103143
this release.
144+
104145
** v0.2.0 - 2020-11-23
146+
105147
This version makes the script lot more complex. If you download only
106148
small threads then this update is not required.
107149

0 commit comments

Comments
 (0)