doc: array: fix typo package->Package, update building script from go…

…tmpl, support go-deps.txt to install dependency that are not in go.mod; support literal include when building README in jinja2 template format

.github/workflows/test.yml

@@ -34,11 +34,24 @@ jobs:
             restore-keys: |
               ${{ runner.os }}-go-
 
-        - name: test
-          run: go test ./...
+        - name: Check go-deps.txt existence
+          id: check_deps
+          uses: andstor/file-existence-action@v1
+          with:
+            files: "go-deps.txt"
 
-        - name: test examples iplist
-          run: cd example/iplist && go run iplist.go
+        - name: Read go-deps.txt
+          id: godeps
+          if: steps.check_deps.outputs.files_exists == 'true'
+          uses: juliangruber/read-file-action@v1
+          with:
+            path: ./go-deps.txt
 
-        - name: test examples slimstar
-          run: cd example/slimstar && go run slimstar.go
+        - name: Install go-deps.txt
+          if: steps.check_deps.outputs.files_exists == 'true'
+          run: |
+            go get ${{ steps.godeps.outputs.content }}
+
+        - name: test
+          run: |
+            go test ./...

README.md

@@ -1,13 +1,13 @@
 # slimarray
 
 [![Travis](https://travis-ci.com/openacid/slimarray.svg?branch=main)](https://travis-ci.com/openacid/slimarray)
-<!-- [![AppVeyor](https://ci.appveyor.com/api/projects/status/m0vvvrru7a1g4mae/branch/main?svg=true)](https://ci.appveyor.com/project/drmingdrmer/slimarray/branch/main) -->
 ![test](https://github.com/openacid/slimarray/workflows/test/badge.svg)
 
 [![Report card](https://goreportcard.com/badge/github.com/openacid/slimarray)](https://goreportcard.com/report/github.com/openacid/slimarray)
 [![Coverage Status](https://coveralls.io/repos/github/openacid/slimarray/badge.svg?branch=main&service=github)](https://coveralls.io/github/openacid/slimarray?branch=main&service=github)
 
 [![GoDoc](https://godoc.org/github.com/openacid/slimarray?status.svg)](http://godoc.org/github.com/openacid/slimarray)
+[![PkgGoDev](https://pkg.go.dev/badge/github.com/openacid/slimarray)](https://pkg.go.dev/github.com/openacid/slimarray)
 [![Sourcegraph](https://sourcegraph.com/github.com/openacid/slimarray/-/badge.svg)](https://sourcegraph.com/github.com/openacid/slimarray?badge)
 
 SlimArray is a space efficient, static `uint32` array.
@@ -151,7 +151,7 @@ func ExampleSlimArray() {
 
 # How it works
 
-package slimarray uses polynomial to compress and store an array of uint32. A
+Package slimarray uses polynomial to compress and store an array of uint32. A
 uint32 costs only 5 bits in a sorted array of a million number in range [0,
 1000*1000].
 

common.mk

@@ -78,7 +78,7 @@ doc:
 	godocdown . > docs/$(NAME).md
 	# "package" is the first phrase in a go doc.
 	# "## Usage" is the start of API section.
-	cat docs/$(NAME).md | awk '/^package /,/^## Usage/' | grep -v '^## Usage' > docs/$(NAME)-package.md
+	cat docs/$(NAME).md | awk '/^Package /,/^## Usage/' | grep -v '^## Usage' > docs/$(NAME)-package.md
 
 
 readme: doc

docs/badges.md

@@ -1,9 +1,9 @@
 [![Travis](https://travis-ci.com/openacid/{{ name }}.svg?branch=main)](https://travis-ci.com/openacid/{{ name }})
-<!-- [![AppVeyor](https://ci.appveyor.com/api/projects/status/m0vvvrru7a1g4mae/branch/main?svg=true)](https://ci.appveyor.com/project/drmingdrmer/{{ name }}/branch/main) -->
 ![test](https://github.com/openacid/{{ name }}/workflows/test/badge.svg)
 
 [![Report card](https://goreportcard.com/badge/github.com/openacid/{{ name }})](https://goreportcard.com/report/github.com/openacid/{{ name }})
 [![Coverage Status](https://coveralls.io/repos/github/openacid/{{ name }}/badge.svg?branch=main&service=github)](https://coveralls.io/github/openacid/{{ name }}?branch=main&service=github)
 
 [![GoDoc](https://godoc.org/github.com/openacid/{{ name }}?status.svg)](http://godoc.org/github.com/openacid/{{ name }})
+[![PkgGoDev](https://pkg.go.dev/badge/github.com/openacid/{{ name }})](https://pkg.go.dev/github.com/openacid/{{ name }})
 [![Sourcegraph](https://sourcegraph.com/github.com/openacid/{{ name }}/-/badge.svg)](https://sourcegraph.com/github.com/openacid/{{ name }}?badge)

docs/slimarray-package.md

@@ -1,4 +1,4 @@
-package slimarray uses polynomial to compress and store an array of uint32. A
+Package slimarray uses polynomial to compress and store an array of uint32. A
 uint32 costs only 5 bits in a sorted array of a million number in range [0,
 1000*1000].
 

docs/slimarray.md

@@ -2,7 +2,7 @@
 --
     import "github.com/openacid/slimarray"
 
-package slimarray uses polynomial to compress and store an array of uint32. A
+Package slimarray uses polynomial to compress and store an array of uint32. A
 uint32 costs only 5 bits in a sorted array of a million number in range [0,
 1000*1000].
 

scripts/build_md.py

@@ -6,10 +6,15 @@
 import subprocess
 
 def render_j2(tmpl_path, tmpl_vars, output_path):
-    template_loader = jinja2.FileSystemLoader(searchpath='./')
-    template_env = jinja2.Environment(loader=template_loader,
+
+    def include_file(name):
+        return jinja2.Markup(loader.get_source(env, name)[0])
+
+    loader = jinja2.FileSystemLoader(searchpath='./')
+    env = jinja2.Environment(loader=loader,
                                       undefined=jinja2.StrictUndefined)
-    template = template_env.get_template(tmpl_path)
+    env.globals['include_file'] = include_file
+    template = env.get_template(tmpl_path)
 
     txt = template.render(tmpl_vars)
 

slimarray.go

@@ -1,4 +1,4 @@
-// package slimarray uses polynomial to compress and store an array of uint32.
+// Package slimarray uses polynomial to compress and store an array of uint32.
 // A uint32 costs only 5 bits in a sorted array of a million number in range [0,
 // 1000*1000].
 //