Update README, doxygen docs

.github/workflows/main.yml

@@ -5,6 +5,12 @@ defaults:
         shell: bash
 
 jobs:
+    spell:
+        runs-on: ubuntu-22.04
+        steps:
+            - run: make install_deps_common
+            - run: make spell
+
     jammy_ccws:
         runs-on: ubuntu-22.04
         steps:

.gitmodules

@@ -0,0 +1,4 @@
+[submodule "doc/gh-pages"]
+	path = doc/gh-pages
+	url = ../intrometry
+	branch = gh-pages

.make/common.mk

@@ -0,0 +1,46 @@
+ROOT_DIR=../../
+BUILD_ROOT?=./build
+BUILD_DIR?=${BUILD_ROOT}/${OPTIONS}
+
+APT_INSTALL=sudo apt install -y --no-install-recommends
+PIP_INSTALL=sudo python3 -m pip install
+GEM_INSTALL=sudo gem install
+
+CLANG_FORMAT?=clang-format15
+SCANBUILD?=scan-build-15
+
+
+help:
+	-@grep --color -Ev "(^	)|(^$$)" Makefile
+	-@grep --color -Ev "(^	)|(^$$)" GNUmakefile
+	-@grep --color -Ev "(^	)|(^$$)" .make/*.mk
+
+
+install_deps_common:
+	${APT_INSTALL} cmake
+	${PIP_INSTALL} scspell3k
+
+
+
+# static checks
+#----------------------------------------------
+
+
+spell_interactive:
+	${MAKE} spell SPELL_XARGS_ARG=-o
+
+# https://github.com/myint/scspell
+spell:
+	${FIND_SOURCES} \
+	    | xargs ${SPELL_XARGS_ARG} scspell --use-builtin-base-dict --override-dictionary ./qa/scspell.dict
+
+
+
+# documentation
+#----------------------------------------------
+doxclean:
+	cd doc/gh-pages; git fetch --all; git checkout gh-pages; git pull
+	find ./doc/gh-pages/ -mindepth 1 -not -name "\.git" | xargs rm -Rf
+
+
+.PHONY: build cmake test

.make/intrometry.mk

@@ -0,0 +1,8 @@
+FIND_SOURCES=find ./test/ ./src ./include/ -iname "*.h" -or -iname "*.cpp"
+
+dox: doxclean
+	cd doc; doxygen
+
+format:
+	${FIND_SOURCES} | xargs ${CLANG_FORMAT} -verbose -i
+

CHANGELOG.md

@@ -0,0 +1,8 @@
+CHANGELOG
+=========
+
+
+Unreleased
+==========
+
+* Initial release

Makefile

@@ -0,0 +1,2 @@
+.include ".make/intrometry.mk"
+.include ".make/common.mk"

README.md

@@ -1,2 +1,18 @@
+<table>
+  <tr>
+    <td align="center">
+        CI status
+    </td>
+  </tr>
+  <tr>
+    <td align="center">
+        <a href="https://github.com/asherikov/intrometry/actions/workflows/main.yml">
+        <img src="https://github.com/asherikov/intrometry/actions/workflows/main.yml/badge.svg" alt="Build Status">
+        </a>
+    </td>
+  </tr>
+</table>
+
 WIP: Ariles-based telemetry publisher.
 
+Documentation: <https://asherikov.github.io/thread_supervisor/doxygen>