From e00e6fcb1b791d1ddda698d668286ecd05bc76ea Mon Sep 17 00:00:00 2001 From: "M.V. Hutz" Date: Sat, 21 Mar 2026 01:14:17 +0000 Subject: [PATCH] docs: add logo for project, expand readme (#7) Reviewed-on: https://git.maximhutz.com/tools/go-cuckoo/pulls/7 Co-authored-by: M.V. Hutz Co-committed-by: M.V. Hutz --- .claude/settings.json | 7 +++++++ .gitea/workflows/ci.yml | 8 ++++++++ .markdownlint.yml | 17 +++++++++++++++++ Makefile | 7 +++++-- README.md | 4 ++-- assets/logo.svg | 1 + assets/logo128x128.png | Bin 0 -> 963 bytes assets/logo16x16.png | Bin 0 -> 418 bytes 8 files changed, 40 insertions(+), 4 deletions(-) create mode 100644 .claude/settings.json create mode 100644 .markdownlint.yml create mode 100644 assets/logo.svg create mode 100644 assets/logo128x128.png create mode 100644 assets/logo16x16.png diff --git a/.claude/settings.json b/.claude/settings.json new file mode 100644 index 0000000..dca3cde --- /dev/null +++ b/.claude/settings.json @@ -0,0 +1,7 @@ +{ + "permissions": { + "allow": [ + "Bash(curl -s -w \"\\\\n---HTTP_STATUS:%{http_code}---\" https://raw.githubusercontent.com/kubernetes/kubernetes/master/.markdownlint.yaml)" + ] + } +} diff --git a/.gitea/workflows/ci.yml b/.gitea/workflows/ci.yml index 7bc91e1..5985296 100644 --- a/.gitea/workflows/ci.yml +++ b/.gitea/workflows/ci.yml @@ -39,6 +39,14 @@ jobs: - name: Run mutation tests run: make lint-makefile + lint-markdown: + name: Markdown Lint + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + + - uses: DavidAnson/markdownlint-cli2-action@v19 + test-unit: name: Unit Tests runs-on: ubuntu-latest diff --git a/.markdownlint.yml b/.markdownlint.yml new file mode 100644 index 0000000..f15868f --- /dev/null +++ b/.markdownlint.yml @@ -0,0 +1,17 @@ +default: true +heading-style: + style: atx +ul-indent: + indent: 2 +line-length: false +no-duplicate-heading: + siblings_only: true +no-inline-html: + allowed_elements: + - br + - details + - summary + - img + - picture + - source +first-line-heading: true diff --git a/Makefile b/Makefile index 2ea9847..bfd252d 100644 --- a/Makefile +++ b/Makefile @@ -1,4 +1,4 @@ -.PHONY: all help install clean test-unit test-mutation test-fuzz test docs lint-go lint-makefile lint +.PHONY: all help install clean test-unit test-mutation test-fuzz test docs lint-go lint-makefile lint-markdown lint help: ## Show this help @grep -E '^[a-zA-Z_-]+:.*##' $(MAKEFILE_LIST) | awk -F ':.*## ' '{printf " %-15s %s\n", $$1, $$2}' @@ -32,7 +32,10 @@ lint-go: ## Lint Go code lint-makefile: ## Lint the Makefile checkmake Makefile -lint: lint-go lint-makefile ## Lint all code +lint-markdown: ## Lint Markdown files + docker run --rm -v $(CURDIR):/workdir davidanson/markdownlint-cli2 "**/*.md" + +lint: lint-go lint-makefile lint-markdown ## Lint all code docs: ## Serve godoc locally @echo ">>> Visit: http://localhost:6060/pkg/$$(go list -m)" diff --git a/README.md b/README.md index 8fd37f8..3ad99b0 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,3 @@ -# go-cuckoo +# Go Cuckoo, by `mvhutz`. Go Cuckoo -A hash table that uses cuckoo hashing to achieve a worst-case O(1) lookup time. \ No newline at end of file +A hash table that uses cuckoo hashing to achieve a worst-case O(1) lookup time. Read more about it in [the package documentation](https://pkg.go.dev/git.maximhutz.com/tools/go-cuckoo). diff --git a/assets/logo.svg b/assets/logo.svg new file mode 100644 index 0000000..cac05b2 --- /dev/null +++ b/assets/logo.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/assets/logo128x128.png b/assets/logo128x128.png new file mode 100644 index 0000000000000000000000000000000000000000..0c92048645008ded69c6d029daff38f0d6728ce9 GIT binary patch literal 963 zcmeAS@N?(olHy`uVBq!ia0vp^4Is?H1|$#LC7xzrVD9pCaSW-L^Y)ITcSxed(T~wC z&YoVvX@L`+1p5pwm~mwaHd-%Sf5Ci3*+upZWw}Zkx7gp_VQJDx+#+4z6c{3Mh^?io z<-m&E+2=g(wP~LFzrA)(`MsTTdN$|xehw1_+Jg#y#LK?;$~5QWN9#@Za^fa^4anivzNUS+swYDtc zdcS$;-g|Gd=D$C4W=m>q>DRSu>hIs3a=juy-BE7;hFyxUm+oMOYlNAx!}%S5%>4SL zm0{QJZ`qb2AAdXc68DPNmX4Y8-}m(Lp58T^`ORCM6YuLE`s|-0T=TokYu^5_)hBn& zRxV(NyB+S0GCl*N3ZHAS^Z#ePnr5@_>b*%{kMBDB@A=*x^}*NF-|w4pef|FU`2VNH z{ZCjj6*G9CgaFW#^yduObM-g*@2#y3k$eB^5BvGA)gPOC+t%dgzd!Zs!i9^A9(&tX zee%0@cg~T*;+9i?zBOB;g$U4Nn~NE~+x+^w?A_w?eEe_nU4L)cu_Nza(vH*5uRja_ z^7+TbOxxu%W=Kpf{r-QYRn>eaEa7_Y9OIme#k=}*&A$9&d{_D7$=&qdahKQMdH>zJ z^j7NY;^Ij!U%E!-&%5&5{KIan{#bXuq;^fU{=JXy&(=>1z3#sI>uyW8(3f9#p1&XU zU*+|?+U{%afA`#f$cG%AkXU&mbKu*|;$1b5Z)HZ7*KU}tyyLszsoyngOU^yq@&33B zgDZL}@O!5i9vXU8V$JT_7fV))pF6$lb+PwO%LA`>^1D9QkKJE=@BKINf?IQCzi}RU zkDl=E%zwlGAdR)i@4@c~TlE*)^1grc%bXwo_n?kDHpg{+=Un3>Z&k2FjelPJ%?ZUU uyXE&iyf?f2xBQfO|MfLqeU`-%obS}xn~z%W68Mk{$}yg0ykmGn{$U&d&J{& z9f0w8xpf1S%1r{_(;_X1$M@+B*Np%|^ffF*AAnkSKo|-X0}xe!lZugZEdt-;>h1}E zUhho{r|s37WgCQ{AeS_$_XaCLE@@)f2BmTnfWY^F1z{+#Y=fL@0Ulu}81?6LhD%zL z*?NN3WCm5ZI6Gw2pHnI~aZ<4j7%f-RDnUer2yl9o#!1C=qh%YsRzEZZ&>1eNbq4^n zr?W^D;5dH}Y1TjGs*v6aa}!iSDp*gjdEA64Rl+JCy(X|&d}$cq8$XVne9l>gasU7T M07*qoM6N<$g5c1tv;Y7A literal 0 HcmV?d00001