aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorChristopher R. Nelson <christopher.nelson@languidnights.com>2024-01-21 10:46:44 -0500
committerChristopher R. Nelson <christopher.nelson@languidnights.com>2024-01-21 10:46:44 -0500
commit490bd1f52fdc5ea7a1bc2a4a0e6d2f985a21feba (patch)
tree324c70ea2894d4eddfb2108b5647144c530c2815
parent0f6b17150c24dd8c4d1eb26df118439088846b9b (diff)
doc: update READMEv0.1
-rw-r--r--README.org13
1 files changed, 10 insertions, 3 deletions
diff --git a/README.org b/README.org
index 8cd41cf..df50fa6 100644
--- a/README.org
+++ b/README.org
@@ -10,7 +10,7 @@ Reading-Heap: a service and clients for managing your media consumption order.
** 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.
+It's a *heap* of things you want to *read*. Shocking, I know. But what does that mean? Simply, it means you add a priority when you put an item on the heap, and when you ask the heap what to read it will take your priorities into account (another name for a heap is a priority queue, after all).
** What sets Reading-Heap apart?
@@ -21,15 +21,23 @@ Reading-Heap is implemented as a service, so any zmq-enabled language can write
** Dependencies
- [[https://www.gnu.org/software/guile/][Guile 3.0]] (or later)
+- [[https://gitlab.com/a-sassmannshausen/guile-config][guile-config]]
- [[https://github.com/aconchillo/guile-json][guile-json]]
- [[https://github.com/jerry40/guile-simple-zmq][Guile-Simple-ZMQ]]
+- [[https://zeromq.org/][ZeroMQ]]
+
+** Build Dependencies
+
+- [[https://www.gnu.org/software/automake/][GNU AutoMake]]
+- [[https://www.gnu.org/software/autoconf/][GNU AutoConf]]
+- (optionally) [[https://gitlab.com/a-sassmannshausen/guile-hall][Guile Hall]] 0.4.1+
** Procedure
The usual autotools make process applies here.
#+BEGIN_SRC bash
- autoreconf -vif
+ ./autogen.sh
./configure
make
sudo make install
@@ -47,4 +55,3 @@ The usual autotools make process applies here.
** TODO Web client
Details Forthcoming
-