Skip to content

Commit

Permalink
#79 Update instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
docktermj committed Aug 30, 2024
1 parent 80252cd commit 0eeb0e2
Show file tree
Hide file tree
Showing 11 changed files with 48 additions and 6 deletions.
3 changes: 2 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,8 @@ hello-world: hello-world-osarch-specific
# -----------------------------------------------------------------------------

.PHONY: dependencies-for-development
dependencies-for-development: dependencies-for-development-osarch-specific
dependencies-for-development: dependencies-for-development-osarch-specific
@go install golang.org/x/tools/cmd/godoc@latest


.PHONY: dependencies
Expand Down
12 changes: 7 additions & 5 deletions docs/development.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ These are "one-time tasks" which may already have been completed.

1. If a web page doesn't appear, visit [localhost:6060].
1. Senzing documentation will be in the "Third party" section.
`github.com` > `senzing-garage` > `sz-sdk-????`
`github.com` > `senzing-garage` > `sz-sdk-proto`

1. When a versioned release is published with a `v0.0.0` format tag,
the reference can be found by clicking on the following badge at the top of the README.md page.
Expand Down Expand Up @@ -287,20 +287,22 @@ The following instructions were used to create a [go module] and other [example
[C++ Quick start]: https://grpc.io/docs/languages/cpp/quickstart/
[Clone repository]: #clone-repository
[clone-repository]: https://github.com/senzing-garage/knowledge-base/blob/main/HOWTO/clone-repository.md
[docker]: https://github.com/senzing-garage/knowledge-base/blob/main/WHATIS/docker.md
[example generated source code]: example_generated_source_code
[Generating client and server code]: https://grpc.io/docs/languages/go/basics/#generating-client-and-server-code
[git]: https://github.com/senzing-garage/knowledge-base/blob/main/WHATIS/git.md
[go module]: go
[Go Quick start]: https://grpc.io/docs/languages/go/quickstart/
[Go Reference Badge]: https://pkg.go.dev/badge/github.com/senzing-garage/sz-sdk-proto.svg
[Go Reference]: https://pkg.go.dev/github.com/senzing-garage/sz-sdk-proto
[go]: https://github.com/senzing-garage/knowledge-base/blob/main/WHATIS/go.md
[gRPC Documents for Go]: https://grpc.io/docs/languages/go/
[Identify Senzing subcomponents]: #identify-senzing-subcomponents
[Java Quick start]: https://grpc.io/docs/languages/java/quickstart/
[make]: https://github.com/senzing-garage/knowledge-base/blob/main/WHATIS/make.md
[Overview for gRPC on .NET]: https://learn.microsoft.com/en-us/aspnet/core/grpc
[PHP Quick start]: https://grpc.io/docs/languages/php/quickstart/
[protoc]: https://github.com/senzing-garage/knowledge-base/blob/main/WHATIS/protoc.md
[Python Quick start]: https://grpc.io/docs/languages/python/quickstart/
[Ruby Quick start]: https://grpc.io/docs/languages/ruby/quickstart/
[Thread safety]: https://grpc.io/docs/languages/go/generated-code/
[docker]: https://github.com/senzing-garage/knowledge-base/blob/main/WHATIS/docker.md
[git]: https://github.com/senzing-garage/knowledge-base/blob/main/WHATIS/git.md
[go]: https://github.com/senzing-garage/knowledge-base/blob/main/WHATIS/go.md
[make]: https://github.com/senzing-garage/knowledge-base/blob/main/WHATIS/make.md
4 changes: 4 additions & 0 deletions go/doc.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
/*
Module sz-sdk-proto is code generated by protoc.
*/
package main
4 changes: 4 additions & 0 deletions go/szconfig/doc.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
/*
Package szconfig...
*/
package szconfig
4 changes: 4 additions & 0 deletions go/szconfigmanager/doc.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
/*
Package szconfigmanager...
*/
package szconfigmanager
4 changes: 4 additions & 0 deletions go/szdiagnostic/doc.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
/*
Package szdiagnostic...
*/
package szdiagnostic
4 changes: 4 additions & 0 deletions go/szengine/doc.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
/*
Package szengine...
*/
package szengine
4 changes: 4 additions & 0 deletions go/szproduct/doc.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
/*
Package szproduct...
*/
package szproduct
5 changes: 5 additions & 0 deletions makefiles/darwin.mk
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,11 @@
# OS specific targets
# -----------------------------------------------------------------------------

.PHONY: clean-osarch-specific
clean-osarch-specific:
@pkill godoc || true


.PHONY: documentation-osarch-specific
documentation-osarch-specific:
@godoc &
Expand Down
5 changes: 5 additions & 0 deletions makefiles/linux.mk
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,11 @@
# OS specific targets
# -----------------------------------------------------------------------------

.PHONY: clean-osarch-specific
clean-osarch-specific:
@pkill godoc || true


.PHONY: dependencies-for-development-osarch-specific
dependencies-for-development-osarch-specific:
@protoc --version
Expand Down
5 changes: 5 additions & 0 deletions makefiles/windows.mk
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,11 @@
# OS specific targets
# -----------------------------------------------------------------------------

.PHONY: clean-osarch-specific
clean-osarch-specific:
@taskkill /f /t/im godoc


.PHONY: documentation-osarch-specific
documentation-osarch-specific:
@start /b godoc
Expand Down

0 comments on commit 0eeb0e2

Please sign in to comment.