summary refs log tree commit diff stats
diff options
context:
space:
mode:
authorAndinus <andinus@nand.sh>2020-11-19 00:42:09 +0530
committerAndinus <andinus@nand.sh>2020-11-19 00:42:09 +0530
commitb30de261361636a723613bfc43e41299c854746f (patch)
tree030f187f7fea855df1963c45774f90f6dbdda0c9
downloaddraco-b30de261361636a723613bfc43e41299c854746f.tar.gz
Initialize draco
-rw-r--r--LICENSE13
-rw-r--r--README.org26
2 files changed, 39 insertions, 0 deletions
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..8cb5164
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,13 @@
+Copyright (c) 2020, Andinus <andinus@nand.sh>
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
diff --git a/README.org b/README.org
new file mode 100644
index 0000000..e67f818
--- /dev/null
+++ b/README.org
@@ -0,0 +1,26 @@
+#+SETUPFILE: ~/.emacs.d/org-templates/projects.org
+#+EXPORT_FILE_NAME: index
+#+TITLE: Draco
+
+Draco is a script to convert reddit thread to Org document. It accepts a
+url & prints the Org document to STDOUT.
+
+It'll also print comments along with their replies. It's limited by
+the reddit API.
+
+| Project Home    | [[https://andinus.nand.sh/draco/][Draco]]           |
+| Source Code     | [[https://git.tilde.institute/andinus/draco/][Andinus / Draco]] |
+| GitHub (Mirror) | [[https://github.com/andinus/draco/][Draco - GitHub]]  |
+
+*Tested on*:
+- OpenBSD 6.8 (Perl v5.30.3)
+
+* Installation
+#+BEGIN_SRC sh
+# Clone the project.
+git clone https://git.tilde.institute/andinus/draco && \
+    cd draco
+
+# Install.
+sudo make install
+#+END_SRC