WIP

README.md

@@ -1,6 +1,9 @@
 # Morton Encoding in Go
 
-[Tests]()
+[![Tests](https://github.com/habedi/morton/actions/workflows/tests.yml/badge.svg)](https://github.com/habedi/morton/actions/workflows/tests.yml)
+[![Go Report Card](https://goreportcard.com/badge/github.com/habedi/morton)](https://goreportcard.com/report/github.com/habedi/morton)
+[![Go Reference](https://pkg.go.dev/badge/github.com/habedi/morton.svg)](https://pkg.go.dev/github.com/habedi/morton)
+[![License](https://img.shields.io/github/license/habedi/morton)](https://github.com/habedi/morton/blob/main/LICENSE)
 
 This is a simple implementation of [Morton encoding](https://en.wikipedia.org/wiki/Z-order_curve) in Go that supports
 encoding 2D and 3D integer vectors into a single dimension and decoding them back to the original vectors.

assets/make_figures.sh

@@ -1,5 +1,8 @@
 #!/bin/bash
 
+# You need to have graphviz installed to run this script
+# sudo apt-get install graphviz # for Debian-based systems
+
 # Make figures from .dot files
 for f in *.dot; do
     dot -Tsvg $f -o ${f%.dot}.svg