summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--AUTHORS3
-rw-r--r--ChangeLog16
-rw-r--r--HACKING9
-rw-r--r--NEWS14
-rw-r--r--reading-heap/hconfig.scm.hall3
5 files changed, 41 insertions, 4 deletions
diff --git a/AUTHORS b/AUTHORS
new file mode 100644
index 0000000..a35788c
--- /dev/null
+++ b/AUTHORS
@@ -0,0 +1,3 @@
+Contributers to Reading-Heap 0.1:
+
+ Christopher R. Nelson <christopher.nelson@languidnights.com>
diff --git a/ChangeLog b/ChangeLog
new file mode 100644
index 0000000..1fab1e8
--- /dev/null
+++ b/ChangeLog
@@ -0,0 +1,16 @@
+* ChangeLog
+
+All notable changes to reading-heap will be mentioned in this file.
+
+The format is inspired by [[https://keepachangelog.com/en/1.1.0/][Keep a Changelog]], and reading-heap follows [[https://semver.org/spec/v2.0.0.html][Semantic Versioning]].
+
+** [[https://codeberg.org/languidnights/reading-heap][0.1.0]]
+
+*** Initial release
+
++ rh-server :: program for managing the heap
++ rh-client :: program for interacting with the server
+ + new: adds item to the heap
+ + next: shows the next (top) item in the heap
+ + consume: removes the next (top) item in the heap
+ + shutdown: shuts down a running server
diff --git a/HACKING b/HACKING
index 88435e9..c928c42 100644
--- a/HACKING
+++ b/HACKING
@@ -11,7 +11,7 @@ By far the easiest way to hack on reading-heap is to develop using Guix:
cd /path/to/source-code
guix shell -Df guix.scm
# In the new shell, run:
- hall build --execute && autoreconf -vif && ./configure && make check
+ hall build --execute && autoreconf -vif && ./configure && make
#+END_SRC
You may also want to set your directory as an authorized directory for
@@ -46,9 +46,14 @@ dependencies manually:
- pkg-config
- texinfo
- guile-hall
+ - guile-config
+ - guile-simple-zmq
+ - zeromq
+ - guile-json
+
Once those dependencies are installed you can run:
#+BEGIN_SRC bash
- hall build -x && autoreconf -vif && ./configure && make check
+ hall build -x && autoreconf -vif && ./configure && make
#+END_SRC
diff --git a/NEWS b/NEWS
new file mode 100644
index 0000000..f1dda63
--- /dev/null
+++ b/NEWS
@@ -0,0 +1,14 @@
+# -*- mode: org; coding: utf-8; -*-
+
+#+TITLE: Reading-Heap NEWS – history of user-visible changes
+#+STARTUP: content hidestars
+
+Copyright © (2024) Christopher R. Nelson <christopher.nelson@languidnights.com>
+
+ Copying and distribution of this file, with or without modification,
+ are permitted in any medium without royalty provided the copyright
+ notice and this notice are preserved.
+
+Please send Reading-Heap bug reports to christopher.nelson@languidnights.com
+
+* Publication at 0.1
diff --git a/reading-heap/hconfig.scm.hall b/reading-heap/hconfig.scm.hall
index 23a3b0a..78f4fae 100644
--- a/reading-heap/hconfig.scm.hall
+++ b/reading-heap/hconfig.scm.hall
@@ -19,5 +19,4 @@
(define %license 'agpl3+)
-(define %copyright '(2023))
-
+(define %copyright '(2024))