Updates to use the cthulhu name with out the go suffix.
This commit is contained in:
1 parent
2ffc987806
commit
7629f838f8
15 files changed
+38
-38
No files matched your search
@@ -1,6 +1,6 @@
|
||||
# Cthulhu Tentacles
|
||||
|
||||
A repository of experimental Tentacles for Cthulhu-Go, maintained by Storm
|
||||
A repository of experimental Tentacles for Cthulhu, maintained by Storm
|
||||
Dragon. It contains [Hello World](hello-world/README.md) and the development
|
||||
[Wormhole tentacle](wormhole/README.md).
|
||||
Repository material and both Tentacles are licensed under GPL-3.0-or-later; see
|
||||
@@ -28,7 +28,7 @@ To write your own, follow the [creation and release tutorial](#create-and-releas
|
||||
|
||||
## Build and check
|
||||
|
||||
Keep the matching experimental `cthulhu-go` checkout beside this directory.
|
||||
Keep the matching experimental `cthulhu` checkout beside this directory.
|
||||
The `go.mod` local replacement uses its Go SDK, including the new
|
||||
uninterruptible presentation option. Building requires Go 1.24 or newer;
|
||||
checks also require Python 3.11 or newer and Make.
|
||||
@@ -41,7 +41,7 @@ make check
|
||||
The executables are `hello-world/bin/hello-world` and
|
||||
`wormhole/bin/wormhole-tentacle`; both are ignored by Git.
|
||||
Checks validate the TOML metadata, registration and suggested bindings, and
|
||||
invoke both Tentacles through the actual Cthulhu-Go host. They produce no speech
|
||||
invoke both Tentacles through the actual Cthulhu host. They produce no speech
|
||||
or Braille and leave the running reader alone.
|
||||
|
||||
## Repository installation
|
||||
@@ -81,12 +81,12 @@ module metadata, trim paths and omit VCS stamping. To build one architecture:
|
||||
python3 -B tools/package.py --architecture amd64
|
||||
```
|
||||
|
||||
Validate the actual host-architecture package through Cthulhu-Go's installer
|
||||
Validate the actual host-architecture package through Cthulhu's installer
|
||||
and command host, without changing the running reader:
|
||||
|
||||
```sh
|
||||
cd ../cthulhu-go
|
||||
CTHULHU_TENTACLE_RELEASE_ROOT=../cthulhu-tentacles GOCACHE=/tmp/cthulhu-go-cache go test ./internal/tentacle -run '^TestBuiltHelloWorldPackageThroughHost$' -count=1 -v
|
||||
cd ../cthulhu
|
||||
CTHULHU_TENTACLE_RELEASE_ROOT=../cthulhu-tentacles GOCACHE=/tmp/cthulhu-cache go test ./internal/tentacle -run '^TestBuiltHelloWorldPackageThroughHost$' -count=1 -v
|
||||
```
|
||||
|
||||
Before publication, review both repositories' changes and contributing guides.
|
||||
@@ -111,7 +111,7 @@ testing, the development launch procedure remains in
|
||||
|
||||
This tutorial creates a native Go Tentacle named **Greeting**, then makes it
|
||||
installable from a repository. The SDK and package format are experimental;
|
||||
use a matching Cthulhu-Go checkout. Currently the installer supports native Linux
|
||||
use a matching Cthulhu checkout. Currently the installer supports native Linux
|
||||
executables, protocol 1.0, command registration and optional presentation access.
|
||||
Python SDK development is separate from this native package workflow. Broader
|
||||
APIs and automatic package updates are still pending.
|
||||
@@ -119,7 +119,7 @@ APIs and automatic package updates are still pending.
|
||||
### 1. Set up the source repository
|
||||
|
||||
You need Go 1.24 or newer, Git, Python 3.11 or newer for this repository's checks,
|
||||
GNU tar and gzip. Keep your new repository beside `cthulhu-go`. From their parent
|
||||
GNU tar and gzip. Keep your new repository beside `cthulhu`. From their parent
|
||||
directory:
|
||||
|
||||
```sh
|
||||
@@ -150,9 +150,9 @@ module example.org/greeting-tentacles
|
||||
|
||||
go 1.24.0
|
||||
|
||||
require git.stormux.org/storm/cthulhu-go v0.0.0
|
||||
require git.stormux.org/storm/cthulhu v0.0.0
|
||||
|
||||
replace git.stormux.org/storm/cthulhu-go => ../cthulhu-go
|
||||
replace git.stormux.org/storm/cthulhu => ../cthulhu
|
||||
```
|
||||
|
||||
The SDK import path names its source project; it does not constrain where you
|
||||
@@ -236,7 +236,7 @@ import (
|
||||
"encoding/json"
|
||||
"os"
|
||||
|
||||
"git.stormux.org/storm/cthulhu-go/sdk/go/tentacle"
|
||||
"git.stormux.org/storm/cthulhu/sdk/go/tentacle"
|
||||
)
|
||||
|
||||
func say_greeting(ctx context.Context, _ json.RawMessage) (any, error) {
|
||||
@@ -284,14 +284,14 @@ From `greeting-tentacles`:
|
||||
```sh
|
||||
gofmt -w greeting/src/main.go
|
||||
mkdir -p greeting/bin
|
||||
CGO_ENABLED=0 GOCACHE=/tmp/cthulhu-go-cache go build -buildvcs=false -mod=readonly -trimpath -o greeting/bin/greeting ./greeting/src
|
||||
GOCACHE=/tmp/cthulhu-go-cache go test ./...
|
||||
CGO_ENABLED=0 GOCACHE=/tmp/cthulhu-cache go build -buildvcs=false -mod=readonly -trimpath -o greeting/bin/greeting ./greeting/src
|
||||
GOCACHE=/tmp/cthulhu-cache go test ./...
|
||||
```
|
||||
|
||||
Invoke the compiled command through the development host. From `cthulhu-go`:
|
||||
Invoke the compiled command through the development host. From `cthulhu`:
|
||||
|
||||
```sh
|
||||
GOCACHE=/tmp/cthulhu-go-cache go run ./cmd/tentacle-host -presentation -command greet "$PWD/../greeting-tentacles/greeting/bin/greeting"
|
||||
GOCACHE=/tmp/cthulhu-cache go run ./cmd/tentacle-host -presentation -command greet "$PWD/../greeting-tentacles/greeting/bin/greeting"
|
||||
```
|
||||
|
||||
Expect JSON containing `speech` and `braille`, both `Hello from Greeting!`.
|
||||
@@ -336,7 +336,7 @@ the manifest on later releases. `set -euo pipefail` stops on build/archive failu
|
||||
set -euo pipefail
|
||||
version=0.1.0
|
||||
for architecture in amd64 arm64; do
|
||||
CGO_ENABLED=0 GOOS=linux GOARCH="$architecture" GOCACHE=/tmp/cthulhu-go-cache \
|
||||
CGO_ENABLED=0 GOOS=linux GOARCH="$architecture" GOCACHE=/tmp/cthulhu-cache \
|
||||
go build -buildvcs=false -mod=readonly -trimpath -ldflags='-s -w' \
|
||||
-o dist/greeting-package/bin/greeting ./greeting/src
|
||||
tar --sort=name --mtime=@0 --owner=0 --group=0 --numeric-owner \
|
||||
|
||||
Reference in new issue
Block a user