# -*- mode: org; coding: utf-8; -*-

#+TITLE: README for Reading-Heap

* Reading-Heap

Reading-Heap: a service and clients for managing your media consumption order.

* Description

** What is Reading-Heap?

Reading-Heap is a reference service and client to manage a "media heap". The basic concept is you put your media, along with a priority, on the heap and the service will calculate which one you should consume next.

** What sets Reading-Heap apart?

Reading-Heap is implemented as a service, so any zmq-enabled language can write a client for it. You can add an article from your phone via a web service, grab the details into your wayland clipboard from the command line, and maybe one day file it into your org-mode agenda buffer via a (upcoming) emacs client.

* Installation

** Dependencies

- [[https://www.gnu.org/software/guile/][Guile 3.0]] (or later)
- [[https://github.com/aconchillo/guile-json][guile-json]]
- [[https://github.com/jerry40/guile-simple-zmq][Guile-Simple-ZMQ]]

** Procedure

The usual autotools make process applies here.

#+BEGIN_SRC bash
  autoreconf -vif
  ./configure
  make
  sudo make install
#+END_SRC

* Usage

** Command-line client

#+BEGIN_SRC bash
  reading-heap-client new --priority -1 --title "Foundation Trilogy" --author "Issac Asimov" --location "SF Bookshelf" --unique_id "0739444050"
  reading-heap-client next
#+END_SRC

** TODO Web client

Details Forthcoming