Added a rough sketch of the specification and project structure.

CHANGELOG.md

@@ -0,0 +1,24 @@
+# Change Log
+All notable changes to this project will be documented in this file. This change log follows the conventions of [keepachangelog.com](http://keepachangelog.com/).
+
+## [Unreleased]
+### Changed
+- Add a new arity to `make-widget-async` to provide a different widget shape.
+
+## [0.1.1] - 2025-10-31
+### Changed
+- Documentation on how to make the widgets.
+
+### Removed
+- `make-widget-sync` - we're all async, all the time.
+
+### Fixed
+- Fixed widget maker to keep working when daylight savings switches over.
+
+## 0.1.0 - 2025-10-31
+### Added
+- Files from the new template.
+- Widget maker public API - `make-widget-sync`.
+
+[Unreleased]: https://sourcehost.site/your-name/elboob/compare/0.1.1...HEAD
+[0.1.1]: https://sourcehost.site/your-name/elboob/compare/0.1.0...0.1.1

README.md

@@ -1,3 +1,39 @@
 # elboob
 
 A site search engine for Cryogen with search on the client side
+
+## Design intention
+
+This project is intended to be in two parts:
+
+### The compiler
+
+A Clojure function which scans a list of directories of Markdown files, and produces a map which keys each lexical token occurring in each file (with Markdown formatting, common words, punctuation etc excepted) to a map which keys the relative file path of each file in which the token occurs to the frequency the token occurs within the file.
+
+Thus, supposing we had one file, with the path name `content/md/posts/aquarius.md` with the content
+
+> # The Age of Aquarius
+>
+> This is the dawning of the Age of Aquarius.
+
+Then the output should be
+
+``` clojure
+{"age" {"content/md/posts/aquarius.md" 2}
+ "aquarius" {"content/md/posts/aquarius.md" 2}
+ "dawning" {"content/md/posts/aquarius.md" 1}}
+```
+
+ This map is then stored in a file `elboob.edn` in the root directory of the Cryogen public output. Whether the source path name (e.g. `content/md/posts/`) should be converted to the target pathname (e.g. `/blog/posts-output/`) at compile time or at search time is something I'll decide later.
+
+ ### The searcher
+
+ The searcher is a little Clojurescript function which, given a sequence of search terms, will read the `elboob.edn` file, will produce a web page showing a list of files which contain one or more of those search terms, ordered by the product of the number of occurences of each word in the file.
+
+ ## Implementation
+
+ Has not started yet.
+
+ ## License
+
+ Copyright © 2025 Simon Brooke. Licensed under the GNU General Public License, version 2.0 or (at your option) any later version.

doc/intro.md

@@ -0,0 +1,3 @@
+# Introduction to elboob
+
+TODO: write [great documentation](http://jacobian.org/writing/what-to-write/)

project.clj

@@ -0,0 +1,8 @@
+(defproject elboob "0.1.0-SNAPSHOT"
+  :description "FIXME: write description"
+  :url "http://example.com/FIXME"
+  :license {:name "EPL-2.0 OR GPL-2.0-or-later WITH Classpath-exception-2.0"
+            :url "https://www.eclipse.org/legal/epl-2.0/"}
+  :dependencies [[org.clojure/clojure "1.11.1"]]
+  :repl-options {:init-ns elboob.core}
+  :source-paths      ["src/clj"])

test/elboob/core_test.clj

@@ -0,0 +1,7 @@
+(ns elboob.core-test
+  (:require [clojure.test :refer :all]
+            [elboob.cc.journeyman.core :refer :all]))
+
+(deftest a-test
+  (testing "FIXME, I fail."
+    (is (= 0 1))))